Mybatis：环境搭建

Posted 2023-04-12 _GGBond_

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Mybatis：环境搭建相关的知识，希望对你有一定的参考价值。

Mybatis（一）：环境搭建

前言
一、MyBatis简介
二、搭建MyBatis
三、核心配置文件详解
四、idea中设置文件模板
- 1、在idea中设置核心配置文件的模板
- 2、在idea中设置映射文件的模板

前言

本博主将用CSDN记录软件开发求学之路上亲身所得与所学的心得与知识，有兴趣的小伙伴可以关注博主！也许一个人独行，可以走的很快，但是一群人结伴而行，才能走的更远！

一、MyBatis简介

1、MyBatis历史

MyBatis最初是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation迁移到了Google Code。随着开发团队转投Google Code旗下，iBatis3.x正式更名为MyBatis。代码于2013年11月迁移到Github。

iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。 iBatis提供的持久层框架包括SQL Maps和Data Access Objects（DAO）。

2、MyBatis特性

⭕ MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架
⭕ MyBatis 避免了几乎所有的 JDBC代码和手动设置参数以及获取结果集
⭕ MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录
⭕ MyBatis 是一个半自动的ORM（ObjectRelation Mapping）框架

3、MyBatis下载

点击跳转下载页面

4、和其它持久化层技术对比

⭕ JDBC

● SQL 夹杂在Java代码中耦合度高，导致硬编码内伤
● 维护不易且实际开发需求中 SQL 有变化，频繁修改的情况多见
● 代码冗长，开发效率低

⭕ Hibernate 和 JPA
● 操作简便，开发效率高
● 程序中的长难复杂 SQL 需要绕过框架
● 内部自动生产的 SQL，不容易做特殊优化
● 基于全映射的全自动框架，大量字段的 POJO 进行部分映射时比较困难
● 反射操作太多，导致数据库性能下降

⭕ MyBatis

●轻量级，性能出色 SQL 和 Java 编码分开，功能边界清晰
●Java代码专注业务、SQL语句专注数据
●开发效率稍逊于HIbernate，但是完全能够接受

二、搭建MyBatis

1、开发环境

⭕ IDEA：idea 2019.2
⭕ 构建工具：maven 3.5.4
⭕ mysql版本：MySQL 5.7
⭕ MyBatis版本：MyBatis 3.5.7

2、创建maven工程

2.1 打包方式：jar

2.2 引入依赖

<dependencies>
  <!-- Mybatis核心 -->
  <dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.7</version>
  </dependency>
 
  <!-- junit测试 -->
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
  </dependency>
 
  <!-- MySQL驱动 -->
  <dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.3</version>
  </dependency>
</dependencies>

3、创建MyBatis的核心配置文件

⭕ 习惯上命名为mybatis-config.xml，这个文件名仅仅只是建议，并非强制要求。
⭕ 将来整合Spring之后，这个配置文件可以省略，所以大家操作时可以直接复制、粘贴。
⭕ 核心配置文件主要用于配置连接数据库的环境以及MyBatis的全局配置信息

mybatis-config.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>

  <!--设置连接数据库的环境-->
  <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"/>
        <property name="username" value="root"/>
        <property name="password" value="0523"/>
      </dataSource>
    </environment>
  </environments>
  
  <!--引入映射文件-->
  <mappers>
    <mapper resource="mappers/UserMapper.xml"/>
  </mappers>
</configuration>

4、创建mapper接口

MyBatis中的mapper接口相当于以前的dao，我们可以理解为与之前我们学习的DAO类相呼应。但是区别在于，mapper仅仅是接口，我们不需要提供它的实现类。

public interface UserMapper 
  /**
  * 添加用户信息
  */
  int insertUser();

5、创建MyBatis的映射文件

⭕ 相关概念：ORM（Object Relationship Mapping）对象关系映射。
● 对象：Java的实体类对象
● 关系：关系型数据库
● 映射：二者之间的对应关系

⭕ 一张数据库的表对应一个DAO类，即一张表对应一个Mapper接口，一个Mapper接口对应一个映射文件，所有有此对应关系：
一张数据库表<===>一个实体类<===>一个DAO类/Mapper接口<===>一个映射文件

Java概念	数据库概念
类	表
属性	字段/列
对象	记录/行

⭕ 映射文件的命名规则：表所对应的实体类的类名+Mapper.xml
例如：表t_user，映射的实体类为User，所对应的映射文件为UserMapper.xml
因此一个映射文件对应一个实体类，对应一张表的操作

⭕ MyBatis映射文件用于编写SQL，访问以及操作表中的数据

⭕ MyBatis映射文件存放的位置是src/main/resources/mappers目录下

⭕ MyBatis中可以面向接口操作数据，要保证两个一致：
● mapper接口的全类名和映射文件的命名空间（namespace）保持一致
● mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致

User类：

public class User 
    private Integer id;

    private String username;

    private String password;

    private Integer age;

    private String sex;

    private String email;
    ...

UserMapper.java：

public interface UserMapper 
    /**
     * MyBatis面向接口编程的两个一致：
     * 1.映射文件的 namespace 要和 mapper 接口的全类名保持一致
     * 2.映射文件中的SQL语句的id要和 mapper 接口中的方法名保持一致
     */

    /**
     *添加用户信息
     */
    int insertUser();

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">
<mapper namespace="com.ir.mybatis.mapper.UserMapper">

          <!--int insertUser();-->
          <insert id="insertUser">
                insert into t_user values(null,'张三','123',23,'女')
          </insert>
          
</mapper>

6、通过junit测试功能

测试：

package com.ir.mybaits.test;

import com.ir.mybatis.mapper.UserMapper;
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 org.junit.Test;

import java.io.IOException;
import java.io.InputStream;

/**
 * @author shkstart
 * @create 2022-07-02 15:36
 */
public class MyBatisTest 
    @Test
    public void testMyBatis() throws IOException 
        //加载核心配置文件---->制作建筑图纸
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        //获取SqlSessionFactoryBuilder---->招募工人
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        //通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory，生产SqlSession对象---->图纸给工人，去造工厂
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
        //创建SqlSession对象，此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务---->工厂生产出产品
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //调用UserMapper接口中的方法，就可以根据UserMapper的全类名匹配元素文件，通过调用的方法名匹配映射文件中的SQL标签，并执行标签中的SQL语句---->产品的功能
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        //测试
        int result = mapper.insertUser();
        //提交事务
        sqlSession.commit();
        System.out.println("result:"+result);

知识点：

⭕ SqlSession：代表Java程序和数据库之间的会话。（HttpSession是Java程序和浏览器之间的会话）

⭕ SqlSessionFactory：是“生产”SqlSession的“工厂”。

⭕工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的相关代码封装到一个“工厂类”中，以后都使用这个工厂类来“生产”我们需要的对象。

7、优化

7.1 优化一：自动提交事务

SqlSession默认不自动提交事务，若需要自动提交事务，可以使用SqlSessionFactory.openSession（true);

7.2 优化二:加入log4j日志功能

（1）加入依赖

<!-- log4j日志 -->
<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>1.2.17</version>
</dependency>

（2）加入log4j的配置文件

⭕ log4j的配置文件名为log4j.xml，存放的位置是src/main/resources目录下

⭕日志的级别:FATAL(致命)>ERROR(错误)>WARN(警告)>INFO(信息)>DEBUG(调试)
从左到右打印的内容越来越详细

log4j.xml：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
 
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
 
  <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
    <param name="Encoding" value="UTF-8" />
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="%-5p %dMM-dd HH:mm:ss,SSS
%m (%F:%L) \\n" />
    </layout>
  </appender>
  <logger name="java.sql">
    <level value="debug" />
  </logger>
  <logger name="org.apache.ibatis">
    <level value="info" />
  </logger>
  <root>
    <level value="debug" />
    <appender-ref ref="STDOUT" />
  </root>
</log4j:configuration>

三、核心配置文件详解

jdbc.properties：

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis
jdbc.username=root
jdbc.password=0523

mybatis-config.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>

        <!--
            MyBatis核心配置文件中，标签的顺序：
            properties?,settings?,typeAliases?,typeHandlers?,
            objectFactory?,objectWrapperFactory?,reflectorFactory?,
            plugins?,environments?,databaseIdProvider?,mappers?
        -->

        <!--引入properties文件-->
        <properties resource="jdbc.properties" />

        <!--设置类型别名-->
        <typeAliases>
                <!--
                    typeAlias：设置某个类型的别名
                    属性：
                        type：设置需要设置别名的类型
                        alias：设置某个类型的别名，若不设置该属性，那么该类型拥有默认的别名，即类名且不区分大小写
                -->
                <!--<typeAlias type="com.atguigu.mybatis.pojo.User"></typeAlias>-->
                <!--以包为单位，将包下所有的类型设置默认的类型别名，即类名且不区分大小写-->
                <package name="com.ir.mybatis.pojo"/>
        </typeAliases>

        <!--
            environments：配置多个连接数据库的环境
            属性：
                default：设置默认使用的环境的id
        -->
        <environments default="development">
                <!--
                    environment：配置某个具体的环境
                    属性：
                        id：表示连接数据库的环境的唯一标识，不能重复
                -->
                <environment id="development">
                        <!--
                            transactionManager：设置事务管理方式
                            属性：
                                type="JDBC|MANAGED"
                                JDBC：表示当前环境中，执行SQL时，使用的是JDBC中原生的事务管理方式，事务的提交或回滚需要手动处理
                                MANAGED：被管理，例如Spring
                        -->
                        <transactionManager type="JDBC"/>
                        <!--
                            dataSource：配置数据源
                            属性：
                                type：设置数据源的类型
                                type="POOLED|UNPOOLED|JNDI"
                                POOLED：表示使用数据库连接池缓存数据库连接
                                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>

                <environment id="test">
                        <transactionManager type="JDBC"/>
                        <dataSource type="POOLED">
                                <property name="driver" value="com.mysql.jdbc.Driver"/>
                                <property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
                                <property name="username" value="root"/>
                                <property name="password" value="123456"/>
                        </dataSource>
                </environment>
        </environments>
        <!--引入映射文件-->
        <mappers>
                <!--<mapper resource="mappers/UserMapper.xml"/>-->
                <!--
                    以包为单位引入映射文件
                    要求：
                    1、mapper接口所在的包要和映射文件所在的包一致
                    2、mapper接口要和映射文件的名字一致:即UserMapper与UserMapper.xml
                -->
                <package name="com.ir.mybatis.mapper"/>
        </mappers>
</configuration>

注意：

⭕ 核心配置文件中的标签必须按照固定的顺序：

properties
settings
typeAliases
typeHandlers
objectFactory
objectWrapperFactory
reflectorFactory
plugins
environments
databaseIdProvider
mappers

⭕ <typeAliases> </typeAliases>

支持以包为单位来设置默认类型

⭕ <mappers></mappers>

● 支持以包为单位来引入映射文件
● 在resources下创建包名时，由于resources下为普通文件，所以并不可以以".“为分隔符的方式来创建嵌套的包名，而应该用以”/"的方式来创建

四、idea中设置文件模板

1、在idea中设置核心配置文件的模板

⭕ mybatis-config官方文档模板：

<?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="$driver"/>
                <property name="url" value="$url"/>
                <property name="username" value="$username"/>
                <property name="password" value="$password"/>
            </dataSource>
        </environment>
    </environments>
    
    <mappers>
        <mapper resource="org/mybatis/example/BlogMapper.xml"/>
    </mappers>
    
<
搭建MyBatis环境

01 搭建的步骤

 
 
02 部署jar包
MyBatis的官网可以下载到最新发布版本的MyBatis，其他发布版本的MyBatis的jar文件也可以从官方网站下载。推荐下载mybatis-3.2.2.zip和mybatis-3-mybatis-3.2.2.zip
将下载的jar包添加到WEB-INF下的lib目录中就可以使用
03 创建MyBatis核心配置文件configuration.xml
MyBatis核心配置文件主要用于配置数据库连接和MyBatis运行时所需的各种特性，包含了设置和影响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>
    <!--环境配置，连接的数据库，这里使用的是MySQL-->
    <environments default="mysql">
        <environment id="mysql">
            <!--指定事务管理的类型，这里简单使用Java的JDBC的提交和回滚设置-->
            <transactionManager type="JDBC"></transactionManager>
            <!--dataSource 指连接源配置，POOLED是JDBC连接对象的数据源连接池的实现-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"></property>
                <property name="url" value="jdbc:mysql://127.0.0.1:3306/mybbs"></property>
                <property name="username" value="root"></property>
                <property name="password" value="root"></property>
            </dataSource>
        </environment>
    </environments>
    <mappers>        <!--这是告诉Mybatis区哪找持久化类的映射文件，对于在src下的文件直接写文件名，            如果在某包下，则要写明路径,如：com/mybatistest/config/User.xml-->
        <mapper resource="User.xml"></mapper>
    </mappers>
</configuration>


configuration：配置文件的根元素节点。
properties：通过resource属性从外部指定properties属性文件（database.properties），该属性文件描述数据库连接的相关配置（数据库驱动、连接数据库的url、数据库用户名、数据库密码），其位置也是在/resources目录下。
settings：设置MyBatis运行中的一些行为，比如此处设置MyBatis的log日志实现为LOG4J，即使用log4j实现日志功能。
environments：表示配置MyBatis的多套运行环境，将SQL映射到多个不同的数据库上，该元素节点下可以配置多个environment子元素节点，但是必须指定其中一个为默认运行环境（通过default
environment：配置MyBatis的一套运行环境，需指定运行环境ID、事务管理、数据源配置等相关信息。
mappers：作用是告诉MyBatis去哪里找到SQL映射文件（该文件内容是开发者定义的映射SQL语句），整个项目中可以有一个或多个SQL映射文件。
mapper:mappers的子元素节点，具体指定SQL映射文件的路径，其中resource属性的值表述了SQL映射文件的路径（类资源路径）。

04 创建实体类和SQL映射文件
实体类：User.java

public class User{
     private Integer id;
     private String name;
     -- 省略get set方法
}

sql映射文件：UserMapper.xml

 
 05 创建测试类
1.读取mybatis的配置文件

 
 2.创建SqlSessionFactory对象，此对象可以完成对配置文件的读取

 
 3.创建SqlSession对象，此对象的作用是调用mapper文件进行数据操作

 
 4.关闭SqlSession对象

 
以上是关于Mybatis：环境搭建的主要内容，如果未能解决你的问题，请参考以下文章 
 [刘阳Java]_快速搭建MyBatis环境_第2讲
 MyBatis(一） —— 环境搭建
 图解Java-MyBatis环境搭建
 MyBatis下载和环境搭建
 myBatis搭建环境
 MyBatis初学者总结-搭建MyBatis环境步骤