入门MyBatis框架你一点都不需要慌

一、框架概述

1.1 什么是框架?

软件的半成品,解决了软件开发过程当中的普适性问题,从而简化了开发步骤,提供了开发的效率

1.2 什么是ORM框架?

ORM(Object Relational Mapping)对象关系映射,将程序中的一个对象与表中的一行数据一一对应

ORM框架提供了持久化类与表的映射关系,在运行时参照映射文件的信息,把对象持久化到数据库中

1.3 使用JDBC完成ORM的缺点

  • 存在大量的冗余代码
  • 手工创建 Connection、Statement 等
  • 手工将结果集封装成实体对象
  • 查询效率低,没有对数据访问进行过优化(Not Cache)

二、MyBatis概述

2.1 什么是MyBatis

MyBatis本是Apache软件基金会的一个开源项目iBatis,2010年这个项目由apache software foundation 迁移到了Google Code,并且改名为MyBatis。2013年11月迁移到Github。MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录

2.2 官网

官方网站:http://www.mybatis.org/mybatis-3/

下载地址:https://github.com/mybatis/mybatis-3/releases/tag/mybatis-3.5.1

2.3 使用

关于对MyBatis的使用,我们创建的Maven项目是不需要下载MyBatis的,而是可以通过在Maven项目中的pom文件中添加MyBatis依赖使用!后续我会把MyBatis的开发流程奉上!

三、搭建MyBatis项目

3.1 创建一个Maven项目

File -> NewProject
image-20200711100406109

image-20200711100406109

|
| 创建Maven项目 |
|

image-20200711100511187

image-20200711100511187

|

3.2 导入MyBatis依赖

在pom.xml文件中添加MyBatis核心依赖和MyBatis Log(日志)依赖

  • 核心依赖即是使用MyBatis必备依赖环境,必须导入
  • MyBatis Log(日志)依赖可以查看MyBatis启动的过程,便于我们纠错、查Bug

注意: 记得把依赖放在标签内,MyBatis必定是与数据库交互的,所以也需要导入mysql驱动依赖

    org.mybatis    mybatis    3.4.6    log4j    log4j    1.2.17    mysql    mysql-connector-java    5.1.47

3.3 创建MyBatis配置文件

创建名为mybatis-config.xml配置文件并配置以下信息

注意: 目前mapper.xml默认建议存放在resources中,路径不能以/开头,后续我会补全到其他配置方法

                                                                                                                                                                                                            

3.4 建表

创建一张表来实现对数据库的操作

create table tb_user(    id       int auto_increment        primary key,    username varchar(30) null,    password varchar(30) null,    gender   char        null,    birth    date        null) charset = utf8;

3.5 书写实体类代码

这里我是用的Lombok插件使用注解来完成Getter、Setter方法和无参、有参构造

package com.mylifes1110.bean;import lombok.AllArgsConstructor;import lombok.Data;import lombok.NoArgsConstructor;import java.util.Date;@Data@NoArgsConstructor@AllArgsConstructorpublic class User {    private Integer id;    private String username;    private String password;    private Boolean gender;    private Date birth;}

3.6 定义Dao层接口

定义一个Dao层接口并编写一个查询方法

注意: 因为我们使用MyBatis框架,所以我们不需要来创建Dao层的实现类了

package com.mylifes1110.dao;import com.mylifes1110.bean.User;public interface UserDao {    User selectUserById(int id);}

3.7 创建并编写Mapper.xml

MyBatis框架是使用Mapper.xml文件来将对象和sql关系映射的,所以我们先在resources文件夹中创建一个UserMapper.xml文件并配置

        

3.7 注册Mapper

将mapper.xml注册到mybatis-config.xml核心配置中

        

3.8 测试方式1(常用)

package com.mylifes1110.dao;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 org.junit.Test;import java.io.IOException;import java.io.InputStream;public class UserMapperTest {    @Test    public void selectUserByIdTest() throws IOException {        // 获得读取MyBatis核心配置文件的流对象        InputStream input = Resources.getResourceAsStream("mybatis-config.xml");        // 根据流对象构建SqlSession连接对象的工厂        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(input);        // 通过工厂获得连接对象sqlSession        SqlSession sqlSession = factory.openSession();        // 通过连接对象获得接口实现类对象        UserDao userDaoImpl = sqlSession.getMapper(UserDao.class);        // 打印结果        System.out.println(userDaoImpl.selectUserById(1));    }}

3.9 测试方式2(了解)

package com.mylifes1110.dao;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 org.junit.Test;import java.io.IOException;import java.io.InputStream;public class UserMapperTest {    @Test    public void selectUserByIdTest2() throws IOException {        // 获得读取MyBatis核心配置文件的流对象        InputStream input = Resources.getResourceAsStream("mybatis-config.xml");        // 根据流对象构建SqlSession连接对象的工厂        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(input);        // 通过工厂获得连接对象sqlSession        SqlSession sqlSession = factory.openSession();        // 通过连接对象直接调用接口中的方法        Object o = sqlSession.selectOne("com.mylifes1110.dao.UserDao.selectUserById", 1);        // 打印结果        System.out.println(o);    }}

四、MyBatis框架使用细节

4.1 解决mapper.xml存放在resources以外路径中的读取问题

在Maven项目中resources目录中的配置文件是不会被加载编译到classes中的,所以如果我们要将mapper.xml文件放在resources文件夹以外的文件夹就不会被编译到,以至于我们的MyBatis使用不了!

问题解决: 为了解决此问题,我们可以在pom.xml文件中声明mapper.xml文件所在其他目录为resources文件夹,这样就可以被编译到classes文件夹中了!

操作: 在pom.xml文件最后追加< build >标签,以便可以将xml文件复制到classes中,并在程序运行时正确读取。

注意: 为了让properties文件也被编译到,也需要在标签内加入配置文件的路径,举一反三,如果哪个文件需要被编译我们就加标签即可!

                        src/main/java                            **/*.xml                        true                            src/main/resources                            **/*.xml                **/*.properties                        true            

4.2 解决JDBC写死问题

目前我们使用的MyBatis是在核心配置中写死了,所以我们必须借助jdbc.properties配置文件来加载jdbc,如下操作:

创建jdbc.properties配置文件

#jdbc.propertiesjdbc.driver=com.mysql.jdbc.Driverjdbc.url=jdbc:mysql://localhost:3306/temp?useUnicode=true&characterEncoding=utf8jdbc.username=rootjdbc.password=123456

修改mybatis-config.xml核心配置文件

                                                                                                                                                                                                                

4.3 类型别名

关于我们在写标签的时候,往往会写大量的resultType,但是该属性需要引入一个类的包路径,如果加入类型别名就可以省去写各种包,只写类名就可以。这样为实体类定义别名,提高书写效率

操作: 标签后面加入如下内容即可使用类型别名

注意: 如下标签内添加以下配置信息,指定类别名和自动扫描包内类的别名二选一,一般是扫描包的好些,因为定义类会无限定义多个类,很麻烦

                

4.4 使用log4j日志依赖

在开始时候我们在pom.xml文件中添加了日志依赖,但是并没有使用该日志依赖。如果使用的话,需要创建一个log4j依赖的配置文件,并配置如下信息

注意: 在配置文中log4j.logger.后面的路径是dao层接口所在路径,我们可以选择执行特定的接口来使用日志功能,也可以选择所有的dao层接口都使用日志功能,这里我将所有的dao层接口都使用了日志功能

向pom.xml文件中添加log4j依赖

    log4j    log4j    1.2.17

创建并配置log4j.properties

# Global logging configurationlog4j.rootLogger=DEBUG, stdout# MyBatis logging configuration...log4j.logger.com.mylifes1110.dao=TRACE# Console output...log4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

日志信息

级别 描述
ALL LEVEL 打开所有日志记录开关;是最低等级的,用于打开所有日志记录。
DEBUG 输出调试信息;指出细粒度信息事件对调试应用程序是非常有帮助的。
INFO 输出提示信息;消息在粗粒度级别上突出强调应用程序的运行过程。
WARN 输出警告信息;表明会出现潜在错误的情形。
ERROR 输出错误信息;指出虽然发生错误事件,但仍然不影响系统的继续运行。
FATAL 输出致命错误;指出每个严重的错误事件将会导致应用程序的退出。
OFF LEVEL 关闭所有日志记录开关;是最高等级的,用于关闭所有日志记录。

4.5 注册Mapper

4.5.1 扫描包注册Mapper

关于注册Mapper,我们在上面知识中使用的是单个Mapper注册。其实我们可以选择一个包来进行注册所有Mapper.xml文件的,这就需要我们使用扫描包内所有的Mapper.xml文件。如果我们使用该方式扫描包内所有Mapper.xml文件,需要遵循如下规则:

  • Mapper.xml文件与Dao层接口放在同一包下
  • Mapper.xml文件与Dao层接口命名必须保持一致,比如:UserMapper.xml和UserMapper.java
        
4.5.2 单一注册Mapper路径问题

关于单一注册Mapper是如下形式,但是将Mapper文件全都放在了resources文件夹下显得乱糟糟的,为了解决这个问题,我们可以在resources文件夹下创建一个名为mappers的文件夹(dir)来存放大量的Mapper.xml文件。那么问题来了路径该怎么写呢?如下:

        

五、MyBatis的CURD操作

注意: 在增删改操作的时候,需要使用sqlSession来提交事务之后才可以完成增删改操作

5.1 参数绑定

5.1.1 序号参数绑定

序号参数绑定即是使用#{arg0}#{arg1}等等代替参数列表中的第一个参数、第二个参数等等。该方法不推荐使用,因为参数的可读性很差!

// Dao层接口User selectUserByUserNameAndPassword(String username, String password);// Mapper.xml
5.1.2 注解参数绑定

注解参数绑定即是使用@Param("字段")来代替参数列表中的对应参数,随后设置好参数在Sql语句中使用#{字段}来取对应值。该方式推荐使用!

// Dao层接口User selectUserByUserNameAndPassword(@Param("username") String username, @Param("password")String password);// Mapper.xml
5.1.3 Map参数绑定

Map参数绑定即是使用Map集合来封装参数,并在方法中传入一个Map集合,随后在Sql语句中使用封装的键来取值。该方式了解即可,操作繁琐,不建议使用!

// Dao层接口User selectUserByUserNameAndPassword(String username, String password);// 测试类创建Map集合,封装数据Map map = new HashMap<>();// 自定义key,绑定参数map.put("username", "root");map.put("password", "123456");User user = userDao.selectUserByUserNameAndPassword(map);// Mapper.xml
5.1.4 对象参数绑定

对象参数绑定即是在Dao层接口方法的参数列表中传入对象,这样在Sql语句中就可以随意取出该对象中的字段值了。因为好多场景需要传入对象,所以该方式方便简单,推荐使用!

// Dao层接口User selectUserByUserNameAndPassword(User user);// Mapper.xml

5.2 查询操作

5.2.1 查询标签

查询标签: SELECT * FROM t_user WHERE username = #{username} and password = #{password}

5.2.3 查询总数据条数

可以使用count(1)来查询总数据条数

// Dao层接口long selectUserCount();// Mapper.xml// 测试类@Testpublic void selectUserCount() throws IOException {    InputStream input = Resources.getResourceAsStream("mybatis-config.xml");    SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(input);    SqlSession sqlSession = factory.openSession();    UserDao userDao = sqlSession.getMapper(UserDao.class);    System.out.println(userDao.selectUserCount());}
5.2.4 模糊查询

Sql中的模糊查询在MyBatis中也是可以使用的,如下是使用注解参数绑定来模糊查询的username字段

注意: 查询List集合,resultType中传入的也是集中中的泛型对象(特殊)

// Dao层接口List selectUserListByUsername1(@Param("username") String username);// Mapper.xml// 查询包含Z的username@Testpublic void selectUserListByUsername1() throws IOException {    InputStream input = Resources.getResourceAsStream("mybatis-config.xml");    SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(input);    SqlSession sqlSession = factory.openSession();    UserDao userDao = sqlSession.getMapper(UserDao.class);    System.out.println(userDao.selectUserListByUsername1("Z"));}

5.3 删除操作

5.3.1 删除标签

注意: 在删除标签中,resultType属性是可以省略的,而IDEA快捷键生成的标签中是默认省略的!

5.3.2 删除

通过id来删除一个用户信息

// Dao层接口int deleteUserById(@Param("id") int id);// Mapper.xml    delete from tb_user where id = #{id}

5.4 修改操作

5.4.1 修改标签

注意:标签中也是可以省略resultType属性值的

5.4.2 修改

通过id来修改一个用户信息

// Dao层接口int updateUserById(User user);// Mapper.xml    update tb_user set    username = #{username}, password = #{password}, gender = #{gender}, birth = #{birth}    where id = #{id}

5.5 新增操作

5.5.1 新增标签

注意:标签中也是可以省略resultType属性值的

5.5.2 新增

新增一个用户信息

// Dao层接口int insertUser(User user);// Mapper.xml    insert into tb_user    (username, password, gender, birth)    values     (#{username}, #{password}, #{gender}, #{birth})

5.6 主键回填操作

5.6.1 什么是主键回填?

关于主键回填正在学习的你也许不知道什么意思,但是我分析一个场景,大概你就会了解了!

场景一(int类型主键): 在开发中,int类型并自增的主键也很常见,但是当你插入一条数据并没有插入主键id时,Sql会帮你自动添加主键id。这就产生了一个弊端,如果我们想插入一条数据并得到这个主键id时就需要再查一次这条数据获取主键id,显然这很麻烦。于是,主键回填即可解决此问题,当你插入一条数据时,int类型的主键id会在insert过程中单独查询一次主键并返回该主键id,这样一个处理Sql的操作就做了两份工作,大大提高了开发效率

场景二(String类型主键): 在开发中,与场景一相同,String类型的主键同样很常见,例如:订单ID通常是一个很长的字符串。而订单ID是可以用UUID()方法和replace()方法来获取的,因为Sql中也是存在这两个方法的,所以我们也可以在插入订单数据的时候生成订单ID填入数据库,同样也可以在插入数据后查询出该订单ID,这样也大大提高了我开发效率

5.6.2 主键回填标签

注意: 使用时,将标签放在标签内。after为后,before为前。意为在插入数据之前主键回填,在查润数据之后主键回填

5.6.3 通过last_insert_id()查询主键(int)

last_insert_id()是MySQL内置的一个函数,我们可以通过select last_insert_id()来查询出最后一条插入数据的整数int类型ID。通过使用标签指定order属性为after来保证在插入数据之后查询出该数据的ID

// 表使用的是User表// Dao层接口int insertUser(User user);// Mapper.xml    select last_insert_id()    insert into tb_user    (username, password, gender, birth)    values    (#{username}, #{password}, #{gender}, #{birth})// 测试类@Testpublic void insertOrder() {    OrderDao orderDao = MyBatisUtils.getMapper(OrderDao.class);    Order order = new Order();    order.setMoney(11.1D);    order.setUserId(2);    System.out.println(orderDao.insertOrder(order));    System.out.println(order.getId());    MyBatisUtils.commit();}
5.6.4 通过uuid()查询主键(String)

UUID()和replace()是MySQL内置的两个内置函数,我们可以通过UUID()方法来生成一个UUID字符串,再使用replace()来替换UUID中的“-”,来生成32位的订单ID字符串,生成订单ID后通过SELECT REPLACE(UUID(),'-','')来查询出添加到数据库中的订单ID

// 创建订单表create table tb_order(    id      varchar(32) not null        primary key,    money   double      null,    user_id int         null) charset = utf8;// Dao层接口int insertOrder(Order order);// Mapper.xml    select replace(UUID(), '-', '')    insert into tb_order    (id, money, user_Id)    values    (#{id}, #{money}, #{userId})

六、封装工具类

6.1 封装工具类分析

  • Resource:用于获得读取配置文件的IO对象,耗费资源,建议通过IO一次性读取所有所需要的数据。
  • SqlSessionFactory:SqlSession工厂类,内存占用多,耗费资源,建议每个应用只创建一个对象。
  • SqlSession:相当于Connection,可控制事务,应为线程私有,不被多线程共享。
  • 将获得连接、关闭连接、提交事务、回滚事务、获得接口实现类等方法进行封装。

6.2 MyBatis工具类

package com.mylifes1110.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.InputStream;/** * @ClassName MyBatisUtils * @Description MyBatis工具类 * @Author Ziph * @Date 2020/7/11 * @Since 1.8 * @Version 1.0 */public class MyBatisUtils {    // 获得SqlSession工厂    private static SqlSessionFactory factory;    // 创建ThreadLocal绑定当前线程中的SqlSession对象    private static final ThreadLocal tl = new ThreadLocal();    static {        try {            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");            factory = new SqlSessionFactoryBuilder().build(is);        } catch (Exception e) {            e.printStackTrace();        }    }    // 获得连接(从tl中获得当前线程SqlSession)    private static SqlSession openSession(){        SqlSession session = tl.get();        if(session == null){            session = factory.openSession();            tl.set(session);        }        return session;    }    // 释放连接(释放当前线程中的SqlSession)    public static void closeSession(){        SqlSession session = tl.get();        session.close();        tl.remove();    }    // 提交事务(提交当前线程中的SqlSession所管理的事务)    public static void commit(){        SqlSession session = openSession();        session.commit();        closeSession();    }    // 回滚事务(回滚当前线程中的SqlSession所管理的事务)    public static void rollback(){        SqlSession session = openSession();        session.rollback();        closeSession();    }    // 获得接口实现类对象    public static  T getMapper(Class clazz){        SqlSession session = openSession();        return session.getMapper(clazz);    }}

你可能感兴趣的:(入门MyBatis框架你一点都不需要慌)