MyBatis中文官方文档地址
我们打开文档,可以看到mybatis的介绍,而介绍下面就是一个紧跟着的入门说明,下面我来写一下mybatis的入门例子,完成上一篇文章中的jdbc完成的功能,并且通过这个例子来初步了解mybatis。
第1步:添加依赖
使用mybatis需要添加mybatis的jar包依赖,这里我们使用比较稳定的3.4.6版本,添加后maven的pom文件如下:
第2步:构建SqlSessionFactory
什么是SqlSessionFactory?每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先定制的 Configuration 的实例构建出 SqlSessionFactory 的实例。下面我通过经典的xml配置构建一个SqlSessionFactory。首先在resource下面新建一个mybatis-config.xml文件,内容如下:
XML 配置文件中包含了对 MyBatis 系统的核心设置,包含获取数据库连接实例的数据源(DataSource)和决定事务作用域和控制方式的事务管理器(TransactionManager)。 XML 配置文件的详细内容后面再探讨。
从 XML 文件中构建 SqlSessionFactory 的实例非常简单,建议使用类路径下的资源文件进行配置(也就是maven的resource目录)。 但是也可以使用任意的输入流(InputStream)实例,包括字符串形式的文件路径或者 file:// 的 URL 形式的文件路径来配置。MyBatis 包含一个名叫 Resources 的工具类,它包含一些实用方法,可使从 classpath 或其他位置加载资源文件更加容易,下面看一下构建代码:
通过以上的配置和代码,我们就有了SqlSessionFactory的实例。
第3步:从 SqlSessionFactory 中获取 SqlSession
既然有了 SqlSessionFactory,顾名思义,我们就可以从中获得 SqlSession 的实例了。SqlSession 完全包含了面向数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。既然SqlSession可以直接执行sql语句,那么我们来把获取SqlSession写成一个公共方法:
接下来的步骤就简单了:
因为SqlSession继承了Closeable,因此我们可以使用TWR的形式:
第4步:定义sql语句
mybatis定义sql语句经典的方式是使用xml文件定义,我们在resource下面的mapper文件夹下面定义一个UserMapper.xml文件,内容如下:
mapper标签上面的文件头的写法都一样,不用细说。所有的sql语句都要定义在mapper标签之间。namespace表示执行sql语句的接口类,类的定义如下:
我们要定义一个新增sql和一个查询sql,首先定义一个实体类:
然后在类中定义两个接口:
然后在UserMapper.xml中定义两个接口对应的sql语句:
查询定义在select标签中,新增定义在insert标签中。id表示同一个sql文件中sql语句的唯一标记,这个标记要和接口中对应的方法的名字一样。parameterType表示入参类型,resultType表示回参类型,新增删除和修改操作默认返回的都是结果的数量,因此不用写返回类型,默认都是整型。SQL语句中的参数都写在#{}里面。
下面把sql语句定义的文件加到SqlSessionFactory的构建文件当中:
这样sql语句就定义好了。
第5步:调用定义好的sql
先来看新增的调用(这里注意,这种写法需要手动commit):
再来看查询的调用:
第6步:执行,查看结果
测试代码:
结果:
上面的例子,我们使用mybatis完成了前面jdbc的功能,有人可能会觉得代码量反而多了,并不比jdbc简单,其实不然。可以想象这种写法在添加新功能的时候的方便性,只需要添加一个sql和一个接口,就可以直接调用完成数据库的操作,mybatis正是通过对公共内容的封装,使代码量下降。同时使开发人员把精力集中在业务业务的逻辑和sql上,避免写一些连接数据库的代码。