当前位置：首页 > news >正文

mybatis 入门案例

news 来源：原创 2025/4/30 21:15:21

前言

我们清楚 mybatis 是一个持久层框架，可以非常便捷的操作数据库。如最常见的对数据进行增删改查操作。

项目准备

1 在mybatis 数据库创建 user 用户表并插入以下两条数据

以下是一个user.sql 脚本文件
如何使用脚本文件可以参照
MySQL数据库的备份与还原_控制台还原mysql数据库-CSDN博客

-- MySQL dump 10.13  Distrib 8.0.37, for Win64 (x86_64)
--
-- Host: 127.0.0.1    Database: mybatis
-- ------------------------------------------------------
-- Server version	8.0.37

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!50503 SET NAMES utf8mb4 */;
/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
/*!40103 SET TIME_ZONE='+00:00' */;
/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;

--
-- Table structure for table `user`
--

DROP TABLE IF EXISTS `user`;
/*!40101 SET @saved_cs_client     = @@character_set_client */;
/*!50503 SET character_set_client = utf8mb4 */;
CREATE TABLE `user` (
  `uid` int NOT NULL AUTO_INCREMENT,
  `uname` varchar(10) COLLATE utf8mb3_croatian_ci NOT NULL,
  `uage` int NOT NULL,
  PRIMARY KEY (`uid`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_croatian_ci;
/*!40101 SET character_set_client = @saved_cs_client */;

--
-- Dumping data for table `user`
--

LOCK TABLES `user` WRITE;
/*!40000 ALTER TABLE `user` DISABLE KEYS */;
INSERT INTO `user` VALUES (1,'张三',20),(2,'李四',18);
/*!40000 ALTER TABLE `user` ENABLE KEYS */;
UNLOCK TABLES;
/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;

/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;

-- Dump completed on 2025-02-17 16:19:22

2 准备需要的依赖

学习maven（添加依赖坐标，maven的常用命令，依赖传递，解决依赖冲突）_maven依赖地址-CSDN博客

通过浏览上面的博客，可以获悉从maven repository【maven中央仓库】中可以得到自己想要的依赖或对应的jar 包

3 检查 idea 自带的maven 是否合适

要求：如果在添加依赖后，无法下载，就需要检查是否要重新更换maven，不再使用自带的maven。

更换的原则，是在maven 官网上找和 IDEA 相匹配的maven 版本号。

如何找到 IDEA 相匹配的maven 版本号？

我们打开IDEA ，找到setting 设置里看到，构建工具，可以知道我们IDEA 需要什么样的版本的maven 。如果没有找到可以找相近的。

怎么下载对应的maven？

可以看下面的博客链接

Maven下载和安装（详细版）_maven download-CSDN博客

demo(案例）

项目目标：打印查询user表 id=1时的用户信息

项目结构

主配置文件（mybatisConfig.xml）映射文件（UserMapper.xml）的准备工作

如何添加（找到）主配置文件，映射文件？

一般当打开maven 构建的项目后，点击 resource，右击新建，看到xml 配置文件，一般是无法直接得到主配置文件模板的。

注意：把下面的配置完成之后，下次创建就可以直接在套用模板使用了，更加方便！

应该怎么做呢？

1 打开IDEA文件，设置，编辑器，看到文件和代码模板

2 .1人为点击添加主配置文件名，文件类型（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>

    <!--settings：控制mybatis全局行为-->
    <settings>
        <!--设置mybatis输出日志-->
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>
    <!--设置别名-->
    <typeAliases>
        <!--name:实体类所在的包名-->
        <package name="实体类所在的包名"/>
    </typeAliases>
    <!-- sql mapper(sql映射文件)的位置-->
    <mappers>
        <!--
          name：是包名， 这个包中的所有mapper.xml一次都能加载
        -->
        <package name="mapper文件所在的包名"/>
    </mappers>
</configuration>

2 .2人为点击添加映射文件名，文件类型（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">

正式开始

mybatisConfig.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>
<!--    resourse 的值是 关于 数据库配置文件。含有url,username,password ,数据库驱动 等信息-->
 <properties resource="db.properties">
 </properties>
<!--    environment 是一个环境，里面包含一个事务管理器，一个数据源 -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"></transactionManager>
            <dataSource type="POOLED">
<!-- 配置数据源信息，主要有 数据库驱动，数据库连接地址，数据库用户名，数据库密码等               -->
                <property name="driver" value="${driverClass}"></property>
                <property name="url" value="${jdbcUrl}"></property>
                <property name="username" value="${username}"></property>
                <property name="password" value="${password}"></property>
            </dataSource>
        </environment>
    </environments>
    <mappers>
  
<!-- 使用mapper 标签 指定mapper映射文件-->
        <mapper resource="mapper/UserMapper.xml"/>
    </mappers>
</configuration>

db.proerties 配置文件（配置数据源信息）

driverClass=com.mysql.cj.jdbc.Driver
jdbcUrl=jdbc:mysql://localhost:3306/mybatis?useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=UTC
username=root
password=123456

存在位置，一般是和主配置文件，映射文件共同放在 resource 文件夹下

mapper (持久层）

UserMapper(接口）

package fs.mapper;

import fs.pojo.User;

public interface UserMapper {
  User findByid(int id);
}

UserMapper.xml 映射文件

通过图片可以看见

namespace：指定 mapper/dao 接口的完整类名

由于你是查询用户信息，因此使用select 标签。以下是select 标签在本案例中的具体展现

id: 指定 mapper/dao 接口的方法名

paramerType: 表示参数类型

resultType: 表示返回值类型

发现 UserMapper 接口名和映射文件名相同

完整代码

<?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="fs.mapper.UserMapper">
    <select id="findByid"  resultType="fs.pojo.User"  parameterType="int">
        select * from user where uid=#{uid}
    </select>
</mapper>

pojo/entity(实体类）

实体类的成员变量，需要和数据库中表的信息相照应

完整代码

package fs.pojo;

public class User {
    private int uid;
    private String uname;
    private String uage;

    public int getUid() {
        return uid;
    }

    public void setUid(int uid) {
        this.uid = uid;
    }

    public String getUname() {
        return uname;
    }

    public void setUname(String uname) {
        this.uname = uname;
    }

    public String getUage() {
        return uage;
    }

    public void setUage(String uage) {
        this.uage = uage;
    }

    @Override
    public String toString() {
        return "User{" +
                "uid=" + uid +
                ", uname='" + uname + '\'' +
                ", uage='" + uage + '\'' +
                '}';
    }
}

Controller 层

UserController 类

完整代码

package fs.Controller;

import fs.pojo.User;
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;

public class UserController {
    public static void main(String[] args) throws IOException {
        //加载主配置文件
        InputStream resource = Resources.getResourceAsStream("mybatisConfig.xml");
        //获取SqlSessionFactory对象
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resource);
        // 获取sqlsession 对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 执行查询
        User user = sqlSession.selectOne("findByid",1);
        System.out.println(user);

    }
}