IDEA Intellij中MyBatis框架搭建全过程及MyBatis工程基本的使用方法

怼烎@ 2023-10-03 19:32 16阅读 0赞

#### 文章目录 ####

*  IDEA Intellij中MyBatis框架搭建全过程
 *   *  1、新建module
     *  2、配置pom.xml
     *  3、配置resources
     *  4、新建包
     *  5、配置mybatis-config.xml
     *  6、配置jdbc.properties
     *   *  注意
     *  7、创建实体类
     *   *  注意：
     *  8、创建mapper接口文件
     *  9、创建映射文件
     *  10、配置SqlSession工具类
 *  MyBatis工程基本的使用方法
 *   *  1、mapper接口文件的使用
     *  2、对应的映射文件的使用
     *  3、创建一个测试类测试一下

## IDEA Intellij中MyBatis框架搭建全过程 ##

### 1、新建module ###

![在这里插入图片描述][68b3e08596fa4be987e4be29a88bebb1.png]  
创建一个maven工程  
![在这里插入图片描述][fb49acba40d944cabd03e35c6b7189b0.png]  
![在这里插入图片描述][ce3edc56a31b4161b263909d8234aee5.png]

### 2、配置pom.xml ###

配置打包方式为jar包;

导入依赖：

<dependencies>
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.5.7</version>
            </dependency>
    
            
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.17</version>
            </dependency>
    
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
    
        </dependencies>

配置好后的pom.xml文件：

<?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>com.atguigu.mybatis</groupId>
        <artifactId>MyBatis_demo3</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
    
        <packaging>jar</packaging>
    
        
        <dependencies>
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.5.7</version>
            </dependency>
    
            
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.17</version>
            </dependency>
    
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
    
        </dependencies>
    
    
    </project>

> 注意事项：mysql-connector-java的版本可以根据本机的mysql版本进行改动  
> 配置完pom.xml后别忘了更新一下:  
> ![在这里插入图片描述][f64bd9a84df84c218cc9db9b743ca48c.png]

### 3、配置resources ###

①新建一个jdbc.properties  
![在这里插入图片描述][319eb6ae5ed04ff2a5d6e4bdbde0fba6.png]  
![在这里插入图片描述][3eb7414a70b54f2fbdeebfd0f14e25f0.png]  
②新建log4j.xml  
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 %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-config.xml  
这个几乎每个MyBatis项目中都会用到，所以建议新建一个代码模板，然后就可以像下面这样直接新建一个有代码模板的文件了  
![在这里插入图片描述][48602362a4814966b383bc365a823e25.png]  
模板内容：

<?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"></properties>
    
        <typeAliases>
            <package name=""></package>
        </typeAliases>
    
        <environments default="development">
            <environment id="development">
                <transactionManager type="JDBC"/>
                <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>
            <package name=""/>
        </mappers>
    </configuration>

> 创建模板的详细步骤参考：[Intellij IDEA中创建MyBatis部分代码模板详细过程][Intellij IDEA_MyBatis]

### 4、新建包 ###

①新建一个pojo包  
![在这里插入图片描述][8fb53a3f4da44bdca485a7f2f927d044.png]

![在这里插入图片描述][80f289bc8b7643f4b7f304105aadfc6b.png]

②创建mapper接口的包：  
![在这里插入图片描述][ca1ba2747fb84cc892aab6143972ac2b.png]  
![在这里插入图片描述][6a1186cbe6944d8487672ae12fb75065.png]  
③创建映射文件所在的包：  
![在这里插入图片描述][a6f09418619c4638884963d7547946da.png]  
注意是在resources里新建文件夹：  
![在这里插入图片描述][a274188d72fc48b1a4f1e6cdb095da93.png]  
一定要注意在resources中新建文件夹时不能用“.”来表示文件夹的包含关系，而要使用“/”,若使用.的话则会被认为是文件夹的名字里面的“.”

### 5、配置mybatis-config.xml ###

①设置包别名  
![在这里插入图片描述][326810248d264dd79590c4317ceca736.png]  
②设置mapper接口所在包：  
![在这里插入图片描述][4d5bd965ba104e86aa142ab764dfea27.png]

### 6、配置jdbc.properties ###

![在这里插入图片描述][7118c39a4e42458ca4d34a81df957ef4.png]

#### 注意 ####

注意在属性前面加“jdbc.”是为了防止重名

注意jdbc.driver处若mysql5等为：

com.mysql.jdbc.Driver

mysql8为：

com.mysql.cj.jdbc.Driver

jdbc.url处：  
mysql5等为：

jdbc:mysql://localhost:3306/数据库名字

mysql8需要为：

jdbc:mysql://localhost:3306/数据库名字?
    serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false

### 7、创建实体类 ###

pojo中一个实体类对应一个数据库中的表  
数据库表中的每个字段名对应 所在表对应的实体类 中的属性  
![在这里插入图片描述][35a979d44b89418e82dc5e45ce1b22f3.png]

#### 注意： ####

在实体类中定义的属性要和数据库表中的字段名和数据类型一一对应：  
![在这里插入图片描述][dc86398fd56f47a48444f4d3f30bea62.png]  
这里提一点：若数据库表中的字段名带有下划线如图中的emp\_name,在实体类中要转换为驼峰命名法，即emp\_name—>empName，但一定注意后面要处理字段名和属性名的映射关系！

然后使用alt+insert生成有参构造，无参构造，getter和setter方法，toString（）方法  
![在这里插入图片描述][51136d97d9e745d2a687418017db0a6c.png]

### 8、创建mapper接口文件 ###

![在这里插入图片描述][ccc2a979d290494cbc5a0047c4b66ef5.png]  
![在这里插入图片描述][1fc9994710c74c18b9f6ba2a5d1708e3.png]

### 9、创建映射文件 ###

![在这里插入图片描述][9e4a123596b143fa9f72508b6c0dd54f.png]  
注意是在resources中之前创建的mapper映射文件夹中创建mybatis-mapper.xml（这个是之前步骤中创建的代码模板，没有的要先创建）  
![在这里插入图片描述][8060364fcc0e42ecb46633d9fae345b3.png]  
注意其命名空间要与mapper接口文件的全类名保持一致！  
![在这里插入图片描述][b08c314e720645f4b860f117c6485949.png]

### 10、配置SqlSession工具类 ###

新建一个package后新建一个java类：  
![在这里插入图片描述][a94797f041774bcab8cad6f46f5c3e27.png]  
SqlSession工具类中内容：

package com.atguigu.mybatis.utils;
    
    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;
    
    /**
     * @projectName: MyBatis_Try
     * @package: com.atguigu.mybatis.utils
     * @className: SqlSessionUtils
     * @author: GCT
     * @description: TODO
     * @date: 2022/7/5 19:54
     * @version: 1.0
     */
    public class SqlSessionUtils {
        
    
        public static SqlSession getSqlSession(){
        
            SqlSession sqlSession = null;
            InputStream is = null;
            try {
        
                is = Resources.getResourceAsStream("mybatis-config.xml");
                SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
                sqlSession = sqlSessionFactory.openSession(true);
            } catch (IOException e) {
        
                e.printStackTrace();
            }
            return sqlSession;
    
    
        }
    
    }

到此为止mybatis的基本配置就基本完成了！！  
以下部分是该mybatis工程中各个部分的大致使用方法介绍  
项目结构概览：  
![在这里插入图片描述][ed169dcbe87d49f4ad702d8f90c5085a.png]

## MyBatis工程基本的使用方法 ##

### 1、mapper接口文件的使用 ###

在mapper接口文件中，我们需要写的是需要用到的数据库操作的方法名及其返回类型，如：  
![在这里插入图片描述][61b72acaf8dd4f2c86cac7258f86e69d.png]

### 2、对应的映射文件的使用 ###

如上述的mapper接口文件EmpMapper对应的映射文件为EmpMapper.xml,在该xml文件中写mapper接口文件中各个方法对应的SQL语句

> ps：一个好习惯：把上面mapper接口文件中的方法名和返回类型直接复制粘贴到映射文件中后注释备用，因为映射文件中的“id”要和对应的方法名相同

![在这里插入图片描述][4727676897cf4cbb810812dc447907a5.png]

### 3、创建一个测试类测试一下 ###

在test文件夹中的java包中新建测试类  
![在这里插入图片描述][361aec0d159b41f78f79dbcb9ae87c8c.png]  
使用@Test注释创建测试方法  
![在这里插入图片描述][3d6b80de2e6e40b4a964b430e2fd4344.png]  
测试文件代码:

import com.atguigu.mybatis.mapper.EmpMapper;
    import com.atguigu.mybatis.pojo.Emp;
    import com.atguigu.mybatis.utils.SqlSessionUtils;
    import org.apache.ibatis.session.SqlSession;
    import org.junit.Test;
    
    import java.util.List;
    
    /**
     * @projectName: MyBatis_Try
     * @package: PACKAGE_NAME
     * @className: ResultMapTest
     * @author: GCT
     * @description: TODO
     * @date: 2022/7/13 11:22
     * @version: 1.0
     */
    public class ResultMapTest {
        
        @Test
        public void testGetAllEmp(){
        
            SqlSession sqlSession = SqlSessionUtils.getSqlSession();
            EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);
            List<Emp> list = mapper.getAllEmp();
            list.forEach(emp -> System.out.println(emp));
        }
    }

然后就可以运行测试代码测试了  
![在这里插入图片描述][a098e0ddd2df4ad9b06e8aaf212bdb99.png]  
运行结果如图：  
![在这里插入图片描述][e353f989765a4b5993f8f15b5b3c31cf.png]  
如果能成功查询到数据库信息证明框架搭建基本没问题了  
但我们可以发现empName显示的为null  
原因是在设置实体类时我们对数据库表中的emp\_name字段使用的属性名为empName，导致无法映射到对应的字段名。但！这是因为字段名有字段名的规则，属性名有属性名的规则，所以这样是没问题的，但要想要成功访问到对应的字段，需要解决字段名和属性名的映射关系！

> 关于解决字段名和属性名的映射关系的几种具体方法参考：[MyBatis中解决字段名和属性名的映射关系的几种方法][MyBatis]

解决完字段名和属性名的映射关系就可以发现各个字段都能正常显示了！  
![在这里插入图片描述][f1a484fe71954c7492bb9cc28bbfd37a.png]  
到这步基本就能掌握MyBatis的使用方法了！

[68b3e08596fa4be987e4be29a88bebb1.png]: https://img-blog.csdnimg.cn/68b3e08596fa4be987e4be29a88bebb1.png
[fb49acba40d944cabd03e35c6b7189b0.png]: https://img-blog.csdnimg.cn/fb49acba40d944cabd03e35c6b7189b0.png
[ce3edc56a31b4161b263909d8234aee5.png]: https://img-blog.csdnimg.cn/ce3edc56a31b4161b263909d8234aee5.png
[f64bd9a84df84c218cc9db9b743ca48c.png]: https://img-blog.csdnimg.cn/f64bd9a84df84c218cc9db9b743ca48c.png
[319eb6ae5ed04ff2a5d6e4bdbde0fba6.png]: https://img-blog.csdnimg.cn/319eb6ae5ed04ff2a5d6e4bdbde0fba6.png
[3eb7414a70b54f2fbdeebfd0f14e25f0.png]: https://img-blog.csdnimg.cn/3eb7414a70b54f2fbdeebfd0f14e25f0.png
[48602362a4814966b383bc365a823e25.png]: https://img-blog.csdnimg.cn/48602362a4814966b383bc365a823e25.png
[Intellij IDEA_MyBatis]: https://blog.csdn.net/GCTTTTTT/article/details/125684936?spm=1001.2014.3001.5501
[8fb53a3f4da44bdca485a7f2f927d044.png]: https://img-blog.csdnimg.cn/8fb53a3f4da44bdca485a7f2f927d044.png
[80f289bc8b7643f4b7f304105aadfc6b.png]: https://img-blog.csdnimg.cn/80f289bc8b7643f4b7f304105aadfc6b.png
[ca1ba2747fb84cc892aab6143972ac2b.png]: https://img-blog.csdnimg.cn/ca1ba2747fb84cc892aab6143972ac2b.png
[6a1186cbe6944d8487672ae12fb75065.png]: https://img-blog.csdnimg.cn/6a1186cbe6944d8487672ae12fb75065.png
[a6f09418619c4638884963d7547946da.png]: https://img-blog.csdnimg.cn/a6f09418619c4638884963d7547946da.png
[a274188d72fc48b1a4f1e6cdb095da93.png]: https://img-blog.csdnimg.cn/a274188d72fc48b1a4f1e6cdb095da93.png
[326810248d264dd79590c4317ceca736.png]: https://img-blog.csdnimg.cn/326810248d264dd79590c4317ceca736.png
[4d5bd965ba104e86aa142ab764dfea27.png]: https://img-blog.csdnimg.cn/4d5bd965ba104e86aa142ab764dfea27.png
[7118c39a4e42458ca4d34a81df957ef4.png]: https://img-blog.csdnimg.cn/7118c39a4e42458ca4d34a81df957ef4.png
[35a979d44b89418e82dc5e45ce1b22f3.png]: https://img-blog.csdnimg.cn/35a979d44b89418e82dc5e45ce1b22f3.png
[dc86398fd56f47a48444f4d3f30bea62.png]: https://img-blog.csdnimg.cn/dc86398fd56f47a48444f4d3f30bea62.png
[51136d97d9e745d2a687418017db0a6c.png]: https://img-blog.csdnimg.cn/51136d97d9e745d2a687418017db0a6c.png
[ccc2a979d290494cbc5a0047c4b66ef5.png]: https://img-blog.csdnimg.cn/ccc2a979d290494cbc5a0047c4b66ef5.png
[1fc9994710c74c18b9f6ba2a5d1708e3.png]: https://img-blog.csdnimg.cn/1fc9994710c74c18b9f6ba2a5d1708e3.png
[9e4a123596b143fa9f72508b6c0dd54f.png]: https://img-blog.csdnimg.cn/9e4a123596b143fa9f72508b6c0dd54f.png
[8060364fcc0e42ecb46633d9fae345b3.png]: https://img-blog.csdnimg.cn/8060364fcc0e42ecb46633d9fae345b3.png
[b08c314e720645f4b860f117c6485949.png]: https://img-blog.csdnimg.cn/b08c314e720645f4b860f117c6485949.png
[a94797f041774bcab8cad6f46f5c3e27.png]: https://img-blog.csdnimg.cn/a94797f041774bcab8cad6f46f5c3e27.png
[ed169dcbe87d49f4ad702d8f90c5085a.png]: https://img-blog.csdnimg.cn/ed169dcbe87d49f4ad702d8f90c5085a.png
[61b72acaf8dd4f2c86cac7258f86e69d.png]: https://img-blog.csdnimg.cn/61b72acaf8dd4f2c86cac7258f86e69d.png
[4727676897cf4cbb810812dc447907a5.png]: https://img-blog.csdnimg.cn/4727676897cf4cbb810812dc447907a5.png
[361aec0d159b41f78f79dbcb9ae87c8c.png]: https://img-blog.csdnimg.cn/361aec0d159b41f78f79dbcb9ae87c8c.png
[3d6b80de2e6e40b4a964b430e2fd4344.png]: https://img-blog.csdnimg.cn/3d6b80de2e6e40b4a964b430e2fd4344.png
[a098e0ddd2df4ad9b06e8aaf212bdb99.png]: https://img-blog.csdnimg.cn/a098e0ddd2df4ad9b06e8aaf212bdb99.png
[e353f989765a4b5993f8f15b5b3c31cf.png]: https://img-blog.csdnimg.cn/e353f989765a4b5993f8f15b5b3c31cf.png
[MyBatis]: https://blog.csdn.net/GCTTTTTT/article/details/125760777?spm=1001.2014.3001.5502
[f1a484fe71954c7492bb9cc28bbfd37a.png]: https://img-blog.csdnimg.cn/f1a484fe71954c7492bb9cc28bbfd37a.png