[推荐] MyBatis框架初学笔记-为之后拾遗

目录

1. mybatis的简介

2.MyBatis的环境搭建

    2.1 导入pom依赖

    2.2 数据库文件导入连接

2.3 修改web.xml文件 

  2.4 安装插件

（1）Free mybatis plugin

（2）Mybatis generator

（3） mybatis tools

（4）maven helper 

2.5 配置文件

         2.5.1 mybatis.cfg.xml文件

2.5.2 generatorConfig.xml文件

 2.6 测试生成代码

3.MyBatis的增删改查

  3.1    写service类，先定义一个接口 BookBiz

 3.2 工具类

 3.3 编写测试类测试

 3.4运行结果

 4.总结

---

1. mybatis的简介

MyBatis本是apache的一个开源项目iBatis，2010年这个项目由apache software foundation迁移到了google code，并且改名为MyBatis。2013年11月迁移到Github。

iBATIS一词来源于"internet"和"abatis"的组合，是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects(DAOs)。MyBatis是一种持久层框架（orm框架），用于将Java对象映射到数据库表中。它提供了一种简单的方式来执行数据库操作，例如查询、插入、更新和删除。
MyBatis通过将SQL语句和Java代码分离来实现数据访问层的解耦。它使用XML或注解来描述数据库操作，并提供了丰富的API来执行这些操作。
MyBatis的核心原理是通过配置文件或注解将Java对象和数据库表进行映射。它还支持事务管理、缓存机制和动态SQL等高级功能，使得开发者能够更加方便地进行数据库操作。
它能够简化数据库访问的开发工作，提高代码的可读性和可维护性。无论是小型项目还是大型企业级应用，MyBatis都是一个值得考虑的选择。

2.MyBatis的环境搭建

    2.1 导入pom依赖

         maven官网下载maven官方下载即可https://maven.apache.org/

<?xml version="1.0" encoding="UTF-8"?>

<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.0</modelVersion>

  <groupId>org.example</groupId>
  <artifactId>mybatis01</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>mybatis01 Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>
    <!-- ********************** junit单元测试依赖 ********************** -->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>

    <!-- ********************** Java Servlet API  ********************** -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>4.0.0</version>
      <scope>provided</scope>
    </dependency>

    <!-- ********************** Mybatis依赖 ********************** -->
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.4.5</version>
    </dependency>

    <!-- ********************** Mysql JDBC驱动 ********************** -->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.44</version>
    </dependency>

    <!-- **********************  日志配置  ********************** -->
    <!--记得修改mybatis.cfg.xml添加如下内容-->
    <!--<setting name="logImpl" value="LOG4J2"/>-->
    <!--核心log4j2jar包-->
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>2.9.1</version>
    </dependency>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-api</artifactId>
      <version>2.9.1</version>
    </dependency>
    <!--web工程需要包含log4j-web，非web工程不需要-->
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-web</artifactId>
      <version>2.9.1</version>

    </dependency>
  </dependencies>

  <build>
    <finalName>mybatis01</finalName>

    <resources>
      <!--解决mybatis-generator-maven-plugin运行时没有将XxxMapper.xml文件放入target文件夹的问题-->
      <resource>
        <directory>src/main/java</directory>
        <includes>
          <include>**/*.xml</include>
        </includes>
      </resource>
      <!--解决mybatis-generator-maven-plugin运行时没有将jdbc.properites文件放入target文件夹的问题-->
      <resource>
        <directory>src/main/resources</directory>
        <includes>
          <include>jdbc.properties</include>
          <include>*.xml</include>
        </includes>
      </resource>
    </resources>

      <plugins>

        <plugin>
          <groupId>org.mybatis.generator</groupId>
          <artifactId>mybatis-generator-maven-plugin</artifactId>
          <version>1.3.2</version>
          <dependencies>
            <!--使用Mybatis-generator插件不能使用太高版本的mysql驱动 -->
            <dependency>
              <groupId>mysql</groupId>
              <artifactId>mysql-connector-java</artifactId>
              <version>5.1.44</version>
            </dependency>
          </dependencies>
          <configuration>
            <overwrite>true</overwrite>
          </configuration>
        </plugin>

        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
  </build>
</project>

  2.2 数据库文件导入连接

2.3 修改web.xml文件 

  2.4 安装插件

        安装以下插件

（1）Free mybatis plugin

                                        有以下作用：  1.注解支持 

                                        2.XML映射文件支持 

                                        3. SQL语句智能提示  

                                        4. 代码生成器 

                                        5. 数据库连接和查询

Free MyBatis Plugin通过提供丰富的功能和工具，简化了  MyBatis开发过程中的各种操作，提高了开发效率和代码质量。

    （2）Mybatis generator

                      有以下作用：1. 自动生成实体类

                                            2. 自动生成Mapper接口（包含了常用的增删改查方法）

                                            3. 生成XML映射文件（包含SQL语句的定义和参数映射关系）

                                            4. 生成的代码可自定义

MyBatis Generator可以根据数据库表结构自动生成CRUD代码，减少手动编写重复代码的工作量，提高开发效率和代码质量。同时，生成的代码可根据需求进行自定义修改和扩展，以满足具体的业务需求。

（3） mybatis tools

                            有以下作用：1. 代码生成（生成对应的实体类、Mapper接口和XML映射）

                                                  2. SQL语句编辑和调试

                                                  3. SQL语句执行和结果查看

                                                  4. 自动生成SQL语句

MyBatis Tools是一个集成在IDE中的插件，提供了一系列辅助开发的功能，如代码生成、SQL语句编辑和调试、SQL语句执行和结果查看等
 

（4）maven helper 

                           有以下作用：1. 依赖架包分析

                                                 2. 快速搜索依赖

                                                 3. 优化依赖

                                                 4. 自动导入依赖

                帮助开发人员更方便地管理和调试 Maven 项目。
 

点击File--->点击setting--->点击Plugins---->搜索框输入下载

 下载完之后重写启动软件

重启之后，就变成这样，已下载即可

2.5 配置文件

                2.5.1 mybatis.cfg.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="jdbc.properties"/>

    <settings>
        <setting name="logImpl" value="LOG4J2"/>
    </settings>

    <!-- 别名 -->
    <typeAliases>
        <!--<typeAlias type="com.javaxl.model.Book" alias="Book"/>-->
    </typeAliases>


    <!-- 配置mybatis运行环境 -->
    <environments default="development">
        <environment id="development">
            <!-- type="JDBC" 代表使用JDBC的提交和回滚来管理事务 -->
            <transactionManager type="jdbc"/>

            <!-- mybatis提供了3种数据源类型，分别是：POOLED,UNPOOLED,JNDI -->
            <!-- POOLED 表示支持JDBC数据源连接池 -->
            <!-- UNPOOLED 表示不支持数据源连接池 -->
            <!-- JNDI 表示支持外部数据源连接池 -->
            <dataSource type="POOLED">
                <property name="driver"
                          value="${jdbc.driver}"/>
                <property name="url"
                          value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
<!--        <mapper resource="com/zking/mapper/BookMapper.xml"/>-->
    </mappers>
</configuration>

2.5.2 generatorConfig.xml文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration>
    <!-- 引入配置文件 -->
    <properties resource="jdbc.properties"/>

    <!--指定数据库jdbc驱动jar包的位置-->
    <classPathEntry location="D:\\maven\\mvn_repository\\mysql\\mysql-connector-java\\5.1.44\\mysql-connector-java-5.1.44.jar"/>

    <!-- 一个数据库一个context -->
    <context id="infoGuardian">
        <!-- 注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/><!-- 是否取消注释 -->
            <property name="suppressDate" value="true"/> <!-- 是否生成注释代时间戳 -->
        </commentGenerator>

        <!-- jdbc连接 -->
        <jdbcConnection driverClass="${jdbc.driver}"
                        connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}"/>

        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 01 指定javaBean生成的位置 -->
        <!-- targetPackage：指定生成的model生成所在的包名 -->
        <!-- targetProject：指定在该项目下所在的路径  -->
        <javaModelGenerator targetPackage="com.sy.model"
                            targetProject="src/main/java">
            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否对model添加构造函数 -->
            <property name="constructorBased" value="true"/>
            <!-- 是否针对string类型的字段在set的时候进行trim调用 -->
            <property name="trimStrings" value="false"/>
            <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!-- 02 指定sql映射文件生成的位置 -->
        <sqlMapGenerator targetPackage="com.sy.mapper"
                         targetProject="src/main/java">
            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 03 生成XxxMapper接口 -->
        <!-- type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象 -->
        <!-- type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象 -->
        <!-- type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
        <javaClientGenerator targetPackage="com.sy.mapper"
                             targetProject="src/main/java" type="XMLMAPPER">
            <!-- 是否在当前路径下新加一层schema,false路径com.oop.eksp.user.model， true:com.oop.eksp.user.model.[schemaName] -->
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 配置表信息 -->
        <!-- schema即为数据库名 -->
        <!-- tableName为对应的数据库表 -->
        <!-- domainObjectName是要生成的实体类 -->
        <!-- enable*ByExample是否生成 example类 -->
        <!--<table schema="" tableName="t_book" domainObjectName="Book"-->
        <!--enableCountByExample="false" enableDeleteByExample="false"-->
        <!--enableSelectByExample="false" enableUpdateByExample="false">-->
        <!--&lt;!&ndash; 忽略列，不生成bean 字段 &ndash;&gt;-->
        <!--&lt;!&ndash; <ignoreColumn column="FRED" /> &ndash;&gt;-->
        <!--&lt;!&ndash; 指定列的java数据类型 &ndash;&gt;-->
        <!--&lt;!&ndash; <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" /> &ndash;&gt;-->
        <!--</table>-->

        <table schema="" tableName="t_mvc_Book" domainObjectName="Book"
               enableCountByExample="false" enableDeleteByExample="false"
               enableSelectByExample="false" enableUpdateByExample="false">
            <!-- 忽略列，不生成bean 字段 -->
            <!-- <ignoreColumn column="FRED" /> -->
            <!-- 指定列的java数据类型 -->
            <!-- <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" /> -->
        </table>

    </context>
</generatorConfiguration>

jar包的位置

 路径位置

 如果想生成很多个表，只需多复制<table></table> 即可，和上面一样即可。

 2.6 测试生成代码

        下面报错了，没有生成代码成功，是因为版本原因，因为数据库是 8.0的版本，现在将版本换成 5.7的版本

换完之后，再次测试

 

3.MyBatis的增删改查

           3.1    写service类，先定义一个接口 BookBiz

package com.sy.biz;
import com.sy.model.Book;
/**
 * @author 谌艳
 * @site www.shenyan.com
 * @create 2023-08-19 20:49
 */
public interface BookBiz {
    int deleteByPrimaryKey(Integer bid);

    int insert(Book record);

    int insertSelective(Book record);

    Book selectByPrimaryKey(Integer bid);

    int updateByPrimaryKeySelective(Book record);

    int updateByPrimaryKey(Book record);

}

接着写一个类实现BookBiz接口

package com.sy;

import com.sy.biz.BookBiz;
import com.sy.mapper.BookMapper;
import com.sy.model.Book;

/**
 * @author 谌艳
 * @site www.shenyan.com
 * @create 2023-08-19 20:52
 */

public abstract class BookBizImpl implements BookBiz {
    private BookMapper bm;
    @Override
    public int deleteByPrimaryKey(Integer bid) {
        return bm.deleteByPrimaryKey(bid);
    }

    @Override
    public int insert(Book record) {
        return bm.insert(record);
    }

    @Override
    public int insertSelective(Book record) {
        return bm.insertSelective(record);
    }

    @Override
    public Book selectByPrimaryKey(Integer bid) {
        return bm.selectByPrimaryKey(bid);
    }

    @Override
    public int updateByPrimaryKeySelective(Book record) {
        return bm.updateByPrimaryKeySelective(record);
    }

    @Override
    public int updateByPrimaryKey(Book record) {
        return bm.updateByPrimaryKey(record);
    }

}

3.2 工具类

        定义一个工厂类生成SqlSession

package com.sy.Utils;
 
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
 
/**
 * @author shenyan
 * @create 2023-08-19 16:22
 */
public class SessionUtil {
    private static SqlSessionFactory sessionFactory;
    private static ThreadLocal<SqlSession> threadLocal = new ThreadLocal<SqlSession>();
    static {
        sessionFactory = new SqlSessionFactoryBuilder().build(SessionUtil.class.getResourceAsStream("/mybatis.cfg.xml"));
    }
 
    public static SqlSession openSession() {
        SqlSession session = threadLocal.get();
        if (null == session) {
            session = sessionFactory.openSession();
            threadLocal.set(session);
        }
        return session;
    }
 
    public static void main(String[] args) {
        SqlSession session = openSession();
        System.out.println(session.getConnection());
        session.close();
//        System.out.println(session.getConnection());
    }
}
 

3.3 编写测试类测试

package com.sy.demo;


import com.sy.BookBizImpl;
import com.sy.Utils.SessionUtil;
import com.sy.biz.BookBiz;
import com.sy.mapper.BookMapper;
import com.sy.model.Book;
import org.apache.ibatis.session.SqlSession;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/**
 * @author 谌艳
 * @site www.shenyan.com
 * @create 2023-08-21 8:47
 */
public class demo1 {
    private BookBiz bookBiz;
    private SqlSession sqlSession;


    @Before
    public  void  before(){
        System.out.println("执行测试方法之前会执行的初始化代码块方法");
        //获取一个数据库会话对象，并将其赋值给sqlSession变量
        this.sqlSession = SessionUtil.openSession();
        //实例化业务逻辑层
        BookBizImpl book = new BookBizImpl();
        //获取接口实例
        BookMapper mapper = this.sqlSession.getMapper(BookMapper.class);
        book.setBm(mapper);
        //最后赋值给bookBiz接口，便于对数据库进行增删改查操作
        this.bookBiz = book;

    }

    @After
    public  void  after(){
        System.out.println("方法调用后执行");
        //提交事务
        this.sqlSession.commit();

    }


    @Test
    public void test1(){
        System.out.println("测试查询方法方法..");
             Book book = bookBiz.selectByPrimaryKey(33);
             System.out.println(book);
    }
    @Test
    public void  text2(){
        System.out.println("测试新增方法");
              int insert = bookBiz.insert(new Book(1,"Mybatis",18.8f));
              System.out.println("所影响的行数"+insert);
    }





}

3.4运行结果

 

 

 

4.总结

学习 MyBatis 后，即可获得以下收获：

• 提高数据库操作效率：MyBatis 封装了繁琐的 JDBC 操作，提供了简洁的 API，使得数据库操作更加方便和高效。你可以通过 MyBatis 快速编写和执行 SQL 语句，减少了手动编写和管理 SQL 的工作量，提高了数据库操作的效率。
• 简化开发流程：MyBatis 的 SQL 映射方式将 SQL 语句与 Java 代码解耦，使得开发人员可以更专注于业务逻辑的实现。你可以通过编写 XML 文件或注解来管理 SQL 语句与 Java 对象之间的映射关系，简化了开发流程，提高了开发效率。
• 提高代码质量：MyBatis 的 SQL 映射方式和动态 SQL 支持使得数据库操作更加灵活和易于维护。你可以根据业务需求动态拼接 SQL 语句，减少了冗余代码的编写。同时，通过将 SQL 语句和 Java 代码解耦，你可以更好地组织和管理代码，提高了代码的可读性和可维护性。
•  增强功能扩展能力：MyBatis 提供了插件机制，你可以编写插件来扩展和增强 MyBatis 的功能。通过插件机制，你可以在 SQL 执行前后进行拦截和增强，实现自定义的业务逻辑。这使得你可以根据具体需求扩展 MyBatis 的功能，满足特定的业务需求。
•  掌握常用持久化框架：MyBatis 是目前广泛使用的 Java 持久化框架之一，学习 MyBatis 可以帮助你掌握常用的持久化框架。这对于从事 Java 后端开发的人员来说是一项重要的技能，能够提升你的就业竞争力。

         总之，学习 MyBatis 可以带给你数据库操作效率的提升、开发流程的简化、代码质量的提高、功能扩展能力的增强，同时也能够掌握常用的持久化框架，为你的职业发展带来积极的影响。