Skip to content

MyBatis框架

环境说明

  • jdk 8 +
  • MySQL 8.0.23
  • maven-3.9.9
  • IDEA

学习前需要掌握

  • JDBC
  • MySQL
  • Java 基础
  • Maven
  • Junit

01、Mybatis简介

image-20241031022205996

1.1、什么是MyBatis

  • MyBatis 是一款优秀的持久层框架
  • MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程
  • MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 实体类 【Plain Old Java Objects,普通的 Java对象】映射成数据库中的记录。
  • MyBatis 本是apache的一个开源项目ibatis, 2010年这个项目由apache 迁移到了google code,并且改名为MyBatis 。
  • 2013年11月迁移到Github .
  • Mybatis官方文档 : http://www.mybatis.org/mybatis-3/zh/index.html
  • GitHub : https://github.com/mybatis/mybatis-3

1.2、持久化

  • 持久化是将程序数据在持久状态和瞬时状态间转换的机制。
    • 即把数据(如内存中的对象)保存到可永久保存的存储设备中(如磁盘)。持久化的主要应用是将内存中的对象存储在数据库中,或者存储在磁盘文件中、XML数据文件中等等。
    • JDBC就是一种持久化机制。文件IO也是一种持久化机制。
    • 在生活中 : 将鲜肉冷藏,吃的时候再解冻的方法也是。将水果做成罐头的方法也是。
  • 为什么需要持久化服务呢?那是由于内存本身的缺陷引起的
    • 内存断电后数据会丢失,但有一些对象是无论如何都不能丢失的,比如银行账号等,遗憾的是,人们还无法保证内存永不掉电。
    • 内存过于昂贵,与硬盘、光盘等外存相比,内存的价格要高2~3个数量级,而且维持成本也高,至少需要一直供电吧。所以即使对象不需要永久保存,也会因为内存的容量限制不能一直呆在内存中,需要持久化来缓存到外存。

1.3、持久层

  • 什么是持久层?
    • 完成持久化工作的代码块 . ——> dao层 【DAO (Data Access Object) 数据访问对象】
    • 大多数情况下特别是企业级应用,数据持久化往往也就意味着将内存中的数据保存到磁盘上加以固化,而持久化的实现过程则大多通过各种关系数据库来完成。
    • 不过这里有一个字需要特别强调,也就是所谓的“层”。对于应用系统而言,数据持久功能大多是必不可少的组成部分。也就是说,我们的系统中,已经天然的具备了“持久层”概念?也许是,但也许实际情况并非如此。之所以要独立出一个“持久层”的概念,而不是“持久模块”,“持久单元”,也就意味着,我们的系统架构中,应该有一个相对独立的逻辑层面,专著于数据持久化逻辑的实现.
    • 与系统其他部分相对而言,这个层面应该具有一个较为清晰和严格的逻辑边界。 【说白了就是用来操作数据库存在的!】

1.4、为什么需要Mybatis

  • Mybatis就是帮助程序猿将数据存入数据库中 , 和从数据库中取数据 .

  • 传统的jdbc操作 , 有很多重复代码块 .比如 : 数据取出时的封装 , 数据库的建立连接等等… , 通过框架可以减少重复代码,提高开发效率 .

  • MyBatis 是一个半自动化的ORM框架 (Object Relationship Mapping) —>对象关系映射

  • 所有的事情,不用Mybatis依旧可以做到,只是用了它,所有实现会更加简单!技术没有高低之分,只有使用这个技术的人有高低之别

  • MyBatis的优点

    • 简单易学:本身就很小且简单。没有任何第三方依赖,最简单安装只要两个jar文件+配置几个sql映射文件就可以了,易于学习,易于使用,通过文档和源代码,可以比较完全的掌握它的设计思路和实现。
    • 灵活:mybatis不会对应用程序或者数据库的现有设计强加任何影响。 sql写在xml里,便于统一管理和优化。通过sql语句可以满足操作数据库的所有需求。
    • 解除sql与程序代码的耦合:通过提供DAO层,将业务逻辑和数据访问逻辑分离,使系统的设计更清晰,更易维护,更易单元测试。sql和代码的分离,提高了可维护性。
    • 提供xml标签,支持编写动态sql。
    • …….
  • 最重要的一点,使用的人多!公司需要!

02、MyBatis第一个程序

思路流程:搭建环境—>导入Mybatis—->编写代码—->测试

2.1、代码演示

  1. 搭建实验数据库

    sql
    CREATE DATABASE `mybatis`;
    USE `mybatis`;
    DROP TABLE IF EXISTS `user`;
    CREATE TABLE `user` (
      `id` int(20) NOT NULL,
      `name` varchar(30) DEFAULT NULL,
      `pwd` varchar(30) DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
    insert  into `user`(`id`,`name`,`pwd`) values (1,'Ethan','123456'),(2,'张三','abcdef'),(3,'李四','987654');
  2. 导入MyBatis相关 jar 包

    • GitHub上找
    xml
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.2</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>
  3. 编写MyBatis核心配置文件

    • 查看帮助文档
    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.cj.jdbc.Driver"/>
                    <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8"/>
                    <property name="username" value="root"/>
                    <property name="password" value="l20031220"/>
                </dataSource>
            </environment>
        </environments>
        <mappers>
            <mapper resource="com/ehtan/dao/userMapper.xml"/>
        </mappers>
    </configuration>
  4. 编写MyBatis工具类

    • 查看帮助文档
    java
    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 MybatisUtils {
        private static SqlSessionFactory sqlSessionFactory;
        static {
            try {
                String resource = "mybatis-config.xml";
                InputStream inputStream = Resources.getResourceAsStream(resource);
                sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        //获取SqlSession连接
        public static SqlSession getSession(){
            return sqlSessionFactory.openSession();
        }
    }
  5. 创建实体类

    java
    public class User {
        private int id;  //id
        private String name;   //姓名
        private String pwd;   //密码
        //构造,有参,无参
        //set/get
        //toString()
    }
  6. 编写Mapper接口类

    java
    import com.ethan.pojo.User;
    import java.util.List;
    public interface UserMapper {
        List<User> selectUser();
    }
  7. 编写Mapper.xml配置文件

    • namespace 十分重要,不能写错!
    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.ethan.dao.UserMapper">
      <select id="selectUser" resultType="com.ethan.pojo.User">
        select * from user
      </select>
    </mapper>
  8. 编写测试类

    • Junit 包测试
    java
    public class MyTest {
        @Test
        public void selectUser() {
            SqlSession session = MybatisUtils.getSession();
            //方法一:
            //List<User> users = session.selectList("com.ethan.mapper.UserMapper.selectUser");
            //方法二:
            UserMapper mapper = session.getMapper(UserMapper.class);
            List<User> users = mapper.selectUser();
            for (User user: users){
                System.out.println(user);
            }
            session.close();
        }
    }
  9. 运行测试

2.2、问题说明

可能出现问题说明:Maven静态资源过滤问题

xml
<resources>
    <resource>
        <directory>src/main/java</directory>
        <includes>
            <include>**/*.properties</include>
            <include>**/*.xml</include>
        </includes>
        <filtering>false</filtering>
    </resource>
    <resource>
        <directory>src/main/resources</directory>
        <includes>
            <include>**/*.properties</include>
            <include>**/*.xml</include>
        </includes>
        <filtering>false</filtering>
    </resource>
</resources>

03、CRUD操作

3.1、namespace

  1. 将上面案例中的接口UserDao改名为UserMapper
  2. UserMapper.xml中的namespace改为为UserMapper的路径 .
  3. 再次测试

结论:

配置文件中namespace中的名称为对应Mapper接口或者Dao接口的完整包名,必须一致!

3.2、select

  • select标签是mybatis中最常用的标签之一
  • select语句有很多属性可以详细配置每一条SQL语句
    • id
      • 命名空间中唯一的标识符
      • 接口中的方法名与映射文件中的SQL语句ID 一一对应
    • resultType
      • SQL语句返回值类型。【完整的类名或者别名】
    • parameterType
      • 传入SQL语句的参数类型 。【万能的Map,可以多尝试使用】

需求:根据id查询用户

  1. 在UserMapper中添加对应方法

    java
    public interface UserMapper {
        //查询全部用户
        List<User> selectUser();
        //根据id查询用户
        User selectUserById(int id);
    }
  2. 在UserMapper.xml中添加Select语句

    xml
    <select id="selectUserById" resultType="com.ethan.pojo.User">
      select * from user where id = #{id}
    </select>
  3. 测试类中测试

    java
    @Test
    public void tsetSelectUserById() {
        SqlSession session = MybatisUtils.getSession();  //获取SqlSession连接
        UserMapper mapper = session.getMapper(UserMapper.class);
        User user = mapper.selectUserById(1);
        System.out.println(user);
        session.close();
    }

课堂练习:根据 密码 和 名字 查询用户

思路一:直接在方法中传递参数

  1. 在接口方法的参数前加 @Param属性
  2. Sql语句编写的时候,直接取@Param中设置的值即可,不需要单独设置参数类型
xml
//通过密码和名字查询用户
User selectUserByNP(@Param("username") String username,@Param("pwd") String pwd);
/*
    <select id="selectUserByNP" resultType="com.ethan.pojo.User">
      select * from user where name = #{username} and pwd = #{pwd}
    </select>
*/

思路二:使用万能的Map

  1. 在接口方法中,参数直接传递Map;

    java
    User selectUserByNP2(Map<String,Object> map);
  2. 编写sql语句的时候,需要传递参数类型,参数类型为map

    xml
    <select id="selectUserByNP2" parameterType="map" resultType="com.ethan.pojo.User">
      select * from user where name = #{username} and pwd = #{pwd}
    </select>
  3. 在使用方法的时候,Map的 key 为 sql中取的值即可,没有顺序要求!

    java
    Map<String, Object> map = new HashMap<String, Object>();
    map.put("username","小明");
    map.put("pwd","123456");
    User user = mapper.selectUserByNP2(map);

总结:

如果参数过多,我们可以考虑直接使用Map实现,如果参数比较少,直接传递参数即可

3.3、insert

我们一般使用insert标签进行插入操作,它的配置和select标签差不多!

需求:给数据库增加一个用户

  1. 在UserMapper接口中添加对应的方法

    java
    //添加一个用户
    int addUser(User user);
  2. 在UserMapper.xml中添加insert语句

    xml
    <insert id="addUser" parameterType="com.ethan.pojo.User">
         insert into user (id,name,pwd) values (#{id},#{name},#{pwd})
    </insert>
  3. 测试

    测试

    java
    @Test
    public void testAddUser() {
        SqlSession session = MybatisUtils.getSession();
        UserMapper mapper = session.getMapper(UserMapper.class);
        User user = new User(5,"王五","zxcvbn");
        int i = mapper.addUser(user);
        System.out.println(i);
        session.commit(); //提交事务,重点!不写的话不会提交到数据库
        session.close();
    }

注意点:增、删、改操作需要提交事务!

3.4、update

我们一般使用update标签进行更新操作,它的配置和select标签差不多!

需求:修改用户的信息

  1. 同理,编写接口方法

    java
    //修改一个用户
    int updateUser(User user);
  2. 编写对应的配置文件SQL

    xml
    <update id="updateUser" parameterType="com.ethan.pojo.User">
        update user set name=#{name},pwd=#{pwd} where id = #{id}
    </update>
  3. 测试

    java
    @Test
    public void testUpdateUser() {
        SqlSession session = MybatisUtils.getSession();
        UserMapper mapper = session.getMapper(UserMapper.class);
        User user = mapper.selectUserById(1);
        user.setPwd("asdfgh");
        int i = mapper.updateUser(user);
        System.out.println(i);
        session.commit(); //提交事务,重点!不写的话不会提交到数据库
        session.close();
    }

3.5、delete

我们一般使用delete标签进行删除操作,它的配置和select标签差不多!

需求:根据id删除一个用户

  1. 同理,编写接口方法

    java
    //根据id删除用户
    int deleteUser(int id);
  2. 编写对应的配置文件SQL

    xml
    <delete id="deleteUser" parameterType="int">
        delete from user where id = #{id}
    </delete>
  3. 测试

    java
    @Test
    public void testDeleteUser() {
        SqlSession session = MybatisUtils.getSession();
        UserMapper mapper = session.getMapper(UserMapper.class);
        int i = mapper.deleteUser(5);
        System.out.println(i);
        session.commit(); //提交事务,重点!不写的话不会提交到数据库
        session.close();
    }

小结:

  • 所有的增删改操作都需要提交事务!
  • 接口所有的普通参数,尽量都写上@Param参数,尤其是多个参数时,必须写上!
  • 有时候根据业务的需求,可以考虑使用map传递参数!
  • 为了规范操作,在SQL的配置文件中,我们尽量将Parameter参数和resultType都写上!

3.6、思考题

模糊查询like语句该怎么写?

第1种:在Java代码中添加sql通配符。

xml
string wildcardname = “%smi%”;
list<name> names = mapper.selectlike(wildcardname);
<select id=”selectlike”>
 select * from foo where bar like #{value}
</select>

第2种:在sql语句中拼接通配符,会引起sql注入

xml
string wildcardname = “smi”;
list<name> names = mapper.selectlike(wildcardname);
<select id=”selectlike”>
     select * from foo where bar like "%"#{value}"%"
</select>