怎么搭建Mybatis框架？手把手带你清晰理解不报错

目录

开发环境

创建maven项目

创建Java实体类

创建mapper接口(XxxMapper)

引入依赖文件（pom.xml）

创建MyBatis的核心配置文件（mybatis-config.xml）

jdbc.properties配置文件

创建MyBatis的映射文件(XxxMapper.XML)

通过junit测试

加入log4j的配置文件

MyBatis框架核心配置文件-----mybatis-config.xml详解

MybatisX插件安装

---

开发环境

IDE：idea 2020.2

构建工具：maven 3.8.4

MySQL版本：MySQL 8

MyBatis版本：MyBatis 3.5.7

MySQL不同版本的注意事项

1、驱动类driver-class-name

MySQL 5版本使用jdbc5驱动，驱动类使用：com.mysql.jdbc.Driver MySQL 8版本使用jdbc8驱动，驱动类使用：com.mysql.cj.jdbc.Driver

2 、连接地址url MySQL 5版本的url：

jdbc:mysql://localhost:3306/ssm

MySQL 8 版本的url：jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC

创建maven项目

如何创建我的上一篇博文已经详细叙述过?Maven从安装到成功创建运行maven项目

先给出此次项目的目录结构，方便后续跟步骤时对应

创建Java实体类

@Data

@NoArgsConstructor

@AllArgsConstructor

这三个注解就是lombok所拥有的，可以生成get set方法、构造器

package com.softeem.bean;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private int id;
    private String username;
    private String password;
    private int age;
    private String sex;
    private String email;
    
}

创建mapper接口(XxxMapper)

MyBatis中的mapper接口相当于以前的dao。但是区别在于，mapper仅仅是接口，我们不需要提供实现类。

public interface UserMapper {

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

}

引入依赖文件（pom.xml）

导入mybatis核心包、junit包、mysql驱动...可直接复制但要注意数据库版本及项目名，复制记得修改

<?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>MyBatisProject01</artifactId>
    <version>1.0-SNAPSHOT</version>


    <dependencies>
        <!-- Mybatis核心 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.7</version>
        </dependency>
    
        <!-- log4j日志 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</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>8.0.16</version>
        </dependency>

<!--        生成get与set方法-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

</project>

创建MyBatis的核心配置文件（mybatis-config.xml）

mybatis-config.xml 可以直接复制粘贴。

核心配置文件主要用于配置连接数据库的环境以及MyBatis的全局配置信息核心配置文件存放的位置是src/main/resources目录下。核心配置文件中将properties文件引入，下面会给出jdbc.properties配置文件的代码。

<?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文件-->
    <properties resource="jdbc.properties" />

    <!--设置类型别名-->
    <typeAliases>
        <!--以包为单位，将包下所有的类型设置默认的类型别名，即类名且不区分大小写。在Mapper.xml文件中返回类型就不用写完整名称了，只需要写实体类名-->
        <package name="com.softeem.bean"/>
    </typeAliases>

    <!--
    environments：配置多个连接数据库的环境属性：
    default：设置默认使用的环境的id
    -->

    <!--设置连接数据库的环境      可以选择要使用的环境-->
    <environments default="development">
        <environment id="development">
            <!-- transactionManager：设置事务管理方式属性
                    type："JDBC/MANGED
                    "-->
            <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>
    </environments>
    <!--引入映射文件-->
    <mappers>
      <!--<mapper resource="mappers/UserMapper.xml"/>-->
      <!--
      以包为单位引入映射文件要求：
      1、mapper接口所在的包要和映射文件所在的包一致
      2、mapper接口要和映射文件的名字一致
      -->
        <package name="com.softeem.mapper"/>
    </mappers>
</configuration>

jdbc.properties配置文件

在MyBatis核心配置中文件中引入的jdbc.properties文件，主要用于配置数据库连接相关的属性，包括数据库的URL、用户名、密码、驱动程序类名等。这些属性会被MyBatis框架读取并用于建立数据库连接。

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useSSL=false
jdbc.username=root
jdbc.password=123456

创建MyBatis的映射文件(XxxMapper.XML)

按照JavaEE的开发模式，有了实体类，接口类接着就是接口的实现类，bean、dao、service三层开发，但是在mybaits框架中我们只用写接口，再创建一个映射文件就能轻松代替三层。

相关概念：ORM（Object Relationship Mapping）对象关系映射。

• 对象：Java的实体类对象
• 关系：关系型数据库
• 映射：二者之间的对应关系

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

1、映射文件的命名规则：

表所对应的实体类的类名+Mapper.xml

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

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

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

2、MyBatis中可以面向接口操作数据，要保证两个一致：

a、mapper接口的全类名和映射文件的命名空间（namespace）保持一致

也就是说java包下的UserMapper和resources下的UserMapper.xml上的包和目录要一致（映射的核心）

b、mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致

<?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.softeem.mapper.UserMapper"> 
 <!--  mapper接口的全类名和映射文件的命名空间（namespace）保持一致 -->

<!--int insertUser(); 接口中方法的方法名与id属性一致-->
<insert id="insertUser">
	insert into t_user values(null,'admin','123456',23,'男','12345@qq.com')
</insert>

</mapper>

通过junit测试

public class UserTest {
    SqlSession sqlSession = null;
    UserMapper userMapper;
    @Before
    public void init() throws IOException {
        //读取MyBatis的核心配置文件
        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();
        //创建SqlSession对象，此时通过SqlSession对象所操作的sql都会自动提交
        sqlSession = sqlSessionFactory.openSession(true);
        userMapper = sqlSession.getMapper(UserMapper.class);
        //通过代理模式创建UserMapper接口的代理实现类对象
        //UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        //调用UserMapper接口中的方法，就可以根据UserMapper的全类名匹配元素文件，通过调用的方法名匹配  映射文件中的SQL标签，并执行标签中的SQL语句
        //int result = userMapper.insertUser();
        //sqlSession.commit();
        //System.out.println("结果："+result);
    }

    @Test
    public void insertUser(){
//        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int i = userMapper.insertUser();
        System.out.println("影响行："+i);
    }
    //控制台输出1，及插入数据库成功

• SqlSession：代表Java程序和数据库之间的会话。（HttpSession是Java程序和浏览器之间的 会话）
• SqlSessionFactory：是“生产”SqlSession的“工厂”。
• 工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的相关代码封装到一个“工厂类”中，以后都使用这个工厂类来“生产”我们需要的对象。

junit测试通过，即整个MyBatis框架搭建成功

加入log4j的配置文件

log4j配置文件的作用是用于配置日志记录器的行为，包括日志输出的格式、级别、目的地等。通过log4j配置文件，开发人员可以灵活地控制应用程序的日志记录行为，以便调试和监控应用程序的运行状态。

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

<?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 %d{MM-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>

MyBatis框架核心配置文件-----mybatis-config.xml详解

mybatis-config.xml文件是MyBatis框架的配置文件，它的作用是配置和定制MyBatis框架的行为。在mybatis-config.xml文件中，可以配置数据库连接信息、映射器（Mapper）文件的位置、全局设置、类型处理器等内容。

具体来说，mybatis-config.xml文件可以包含以下内容：

1. 数据库连接信息：配置数据库的URL、用户名、密码、驱动程序类名等信息，用于建立与数据库的连接。

2. 映射器（Mapper）文件的位置：指定MyBatis框架可以找到映射器文件的路径，以便加载映射器文件中定义的SQL语句和映射规则。

3. 全局设置：可以配置全局的属性和设置，例如缓存配置、日志配置、插件等。

4. 类型处理器：配置自定义的类型处理器，用于处理数据库字段和Java对象之间的类型转换。

5. 其他高级配置：例如配置环境、事务管理器、缓存等高级特性。

通过mybatis-config.xml文件，可以灵活地配置MyBatis框架的行为，以满足不同项目的需求。这种分离配置的方式使得MyBatis框架具有很好的可定制性和扩展性。

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

properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,refl ectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?

MybatisX插件安装

这个插件安装后开发会更加方便