使用idea创建一个mybatis项目并进行初步使用

「爱情、让人受尽委屈。」 2023-09-26 18:05 46阅读 0赞

入门小白，第一次写博客，如有不足之处请各位大佬及时指出，不胜感激！（抱拳）

## 简单了解MyBatis ##

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

### 什么是框架？ ###

Java框架就是一些类和接口的集合，通过这些类和接口协调来完成一系列的程序实现。简单来说就是一个模板，规定好了很多的格式，要求开发者，按照指定格式填写代码，完成指定功能。学习如何使用框架，目的是为了提高开发效率，而不是研究框架底层。

### 基于maven创建一个简单的Mybatis项目 ###

#### 一、创建项目 ####

首先打开idea，选择新建一个maven项目，可以选择从原型中创建一个quickstart项目  
![选择新建一个Simple Maven项目也可以，两者之间的区别感兴趣的朋友可以通过其他途径查看][Simple Maven]点击next  
![在这里插入图片描述][daaa1857bac744a7844d410d26c50197.png]![在这里插入图片描述][30b2b767e2ad4ef18a90e1e8255b9afe.png]

#### 二、引入依赖 ####

项目创建完毕，在pom.xml文件中引入所需的依赖，并且可以将**build**标签内容删除，目前用不到。  
所需依赖放在这里

<dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
          <version>8.0.28</version>
        </dependency>
    
        
        <dependency>
          <groupId>org.mybatis</groupId>
          <artifactId>mybatis</artifactId>
          <version>3.5.6</version>
        </dependency>

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

#### 三、完善项目结构 ####

接下来完善项目结构。右击main目录，依次new->Directory,在弹窗中选择resources，双击后将会在main目录下新建一个resources文件夹作为资源配置文件夹。  
![在这里插入图片描述][3eadcdb5cbfa4d6bbe9e9b48457dc9d9.png]继续完善项目结构，在resources目录下依次创建数据库配置文件db.properties及mybatis的配置文件mybatis-config.xml。db.properties内容为：

driver=com.mysql.jdbc.Driver
    url=jdbc:mysql://localhost:3306/test?useSSL=false
    username=root
    password=你的密码

![在这里插入图片描述][053ca1ce6cbd46138b5ec1e0f381da94.png]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>
        
        <properties resource="db.properties"></properties>
        <settings>
            
            <setting name="mapUnderscoreToCamelCase" value="true"/>
    
        </settings>
        
        <typeAliases>
            <package name="com.kkjf.bean"/>
        </typeAliases>
    
    
        
        <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="com/kkjf/mapper/UserMapper.xml"/>
        </mappers>
    </configuration>

![在这里插入图片描述][ae036b13643d42c6a5a15a57ba78b7ec.png]  
此时的项目结构为  
![在这里插入图片描述][21fb3e671b164fd2b350a9b8afe5bfd5.png]

#### 四、数据库创建与连接测试 ####

使用mybatis的目的是为了能够操纵数据库，现在在我的test数据库中有一个张表为user，这里建表过程就不做累述。  
![在这里插入图片描述][c33e1bf9ffb84489885ef525bebbb977.png]然后可以通过idea内置的数据库连接器简单测试一下能否正常连接数据库，点击左上角的+号  
![在这里插入图片描述][4561ac6d2c4a400e996f118615bcc1bd.png]  
输入数据库名，账号，密码，点击Test Connection测试连接，有些可能会报如下的错误,大概意思是时区无效。

上述问题的解决方案如下：选择Driver为MySQL for 5.1，再次点击Test Connection，连接成功  
![在这里插入图片描述][69363dea98f547c28c090ddfca7f05b0.png]连接成功后点击apply->OK，在查询页面写一个SQL测试效果  
![在这里插入图片描述][69438adac55b41e79726160527fd3c1a.png]

#### 五、创建bean类、sqlmapper文件等 ####

在\\java\\com\\kkjf目录下新建bean包，里边创建User类，生成setter，getter方法、无参，有参构造方法、tostring方法，使用注解模式也可以。

package com.kkjf.bena;
    
    public class User {
        
        private Integer id;           //id
        private  String username;     //用户名
        private String password;      //密码
        private String sex;           //性别
        private Integer age;          //年龄
    
        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 getSex() {
        
            return sex;
        }
    
        public void setSex(String sex) {
        
            this.sex = sex;
        }
    
        public Integer getAge() {
        
            return age;
        }
    
        public void setAge(Integer age) {
        
            this.age = age;
        }
    
        public User() {
        
        }
    
        public User(Integer id, String username, String password, String sex, Integer age) {
        
            this.id = id;
            this.username = username;
            this.password = password;
            this.sex = sex;
            this.age = age;
        }
    
        @Override
        public String toString() {
        
            return "User{" +
                    "id=" + id +
                    ", username='" + username + '\'' +
                    ", password='" + password + '\'' +
                    ", sex='" + sex + '\'' +
                    ", age=" + age +
                    '}';
        }
    
    }

![在这里插入图片描述][29f311b1fb1e4e739bb33e62efafc1e0.png]  
继续完善项目结构，新建了一个UserMapper的接口以及一个UserMapper.xml的配置文件  
![在这里插入图片描述][98e099c67c0b4557bae56f813900347c.png]  
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.kkjf.mapper.UserMapper">
    
        
        <select id="selectOne" resultType="com.kkjf.bena.User">
            select * from person where id = #{id}
        </select>
    
    </mapper>

![在这里插入图片描述][74213602b84d40cba99fc2e0ca1d2bc1.png]UserMapper接口的内容为：

package com.kkjf.mapper;
    
    import com.kkjf.bena.User;
    
    public interface UserMapper {
        
    
        User selectOne(Integer id);
    }

![在这里插入图片描述][59b091ae12ca47328ebcf59b50282914.png]此时一个mybatis项目的准备工作基本完毕！接下来进行测试。

#### 六、测试效果 ####

在APPTest测试类中输入以下内容：

@Test
        public void aa() throws IOException {
        
            // 1. 初始化mybatis配置
            String confPath = "mybatis-config.xml";
            InputStream in = Resources.getResourceAsStream(confPath);
            // 2. 构建SqlSessionFactory对象
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
            // 3. 获取SqlSession对象，默认事务不自动提交
            SqlSession sqlSession = sqlSessionFactory.openSession();
            // 4. 获取Mapper
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            User user = mapper.selectOne(1);
            System.out.println(user.toString());
        }

![在这里插入图片描述][0ab265563b814dd1987d9a88c2b72b47.png]根据控制台输出可以发现测试成功。

#### 总结： ####

1.使用mybatis的目的是为了连接数据库并简化SQL结果集的获取，并实现一定的解耦。因此在配置过程中我们应该有配置数据库并进行连接的过程，即mybatis-config.xml中**environments**标签中的内容。

2.mybatis-config.xml配置中**properties**标签的目的是为了引入外部配置文件，即本项目中的db.properties。我们可以发现db.properties中的内容是以Key-Value的形式存在的，mybatis-config.xml通过**properties**标签引入db.properties文件后，就可以通过 $\{Key\} 的形式获取到对应的Value内容。

3.我们可以将mybatis-config.xml理解为mybatis项目的入口，然后我们会通过**mappers**标签来标记项目后已有的sqlmapper文件（即写有自定义SQL语句的xxxMapper.xml文件），在sqlmapper文件中会通过

方式标记该sqlmapper文件暴露在外的接口。

[Simple Maven]: https://img-blog.csdnimg.cn/4ecf3622e79347e1b606771a0814548c.png
[daaa1857bac744a7844d410d26c50197.png]: https://img-blog.csdnimg.cn/daaa1857bac744a7844d410d26c50197.png
[30b2b767e2ad4ef18a90e1e8255b9afe.png]: https://img-blog.csdnimg.cn/30b2b767e2ad4ef18a90e1e8255b9afe.png
[a0a5ef7fb81f4521be07550a5652ea52.png]: https://img-blog.csdnimg.cn/a0a5ef7fb81f4521be07550a5652ea52.png
[3eadcdb5cbfa4d6bbe9e9b48457dc9d9.png]: https://img-blog.csdnimg.cn/3eadcdb5cbfa4d6bbe9e9b48457dc9d9.png
[053ca1ce6cbd46138b5ec1e0f381da94.png]: https://img-blog.csdnimg.cn/053ca1ce6cbd46138b5ec1e0f381da94.png
[ae036b13643d42c6a5a15a57ba78b7ec.png]: https://img-blog.csdnimg.cn/ae036b13643d42c6a5a15a57ba78b7ec.png
[21fb3e671b164fd2b350a9b8afe5bfd5.png]: https://img-blog.csdnimg.cn/21fb3e671b164fd2b350a9b8afe5bfd5.png
[c33e1bf9ffb84489885ef525bebbb977.png]: https://img-blog.csdnimg.cn/c33e1bf9ffb84489885ef525bebbb977.png
[4561ac6d2c4a400e996f118615bcc1bd.png]: https://img-blog.csdnimg.cn/4561ac6d2c4a400e996f118615bcc1bd.png
[69363dea98f547c28c090ddfca7f05b0.png]: https://img-blog.csdnimg.cn/69363dea98f547c28c090ddfca7f05b0.png
[69438adac55b41e79726160527fd3c1a.png]: https://img-blog.csdnimg.cn/69438adac55b41e79726160527fd3c1a.png
[29f311b1fb1e4e739bb33e62efafc1e0.png]: https://img-blog.csdnimg.cn/29f311b1fb1e4e739bb33e62efafc1e0.png
[98e099c67c0b4557bae56f813900347c.png]: https://img-blog.csdnimg.cn/98e099c67c0b4557bae56f813900347c.png
[74213602b84d40cba99fc2e0ca1d2bc1.png]: https://img-blog.csdnimg.cn/74213602b84d40cba99fc2e0ca1d2bc1.png
[59b091ae12ca47328ebcf59b50282914.png]: https://img-blog.csdnimg.cn/59b091ae12ca47328ebcf59b50282914.png
[0ab265563b814dd1987d9a88c2b72b47.png]: https://img-blog.csdnimg.cn/0ab265563b814dd1987d9a88c2b72b47.png