Mybatis学习--入门

2023-11-11 12:44:58

Mybatis学习–入门

1.导入依赖

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
</dependency>

2.构建SqlSessionFactory(XML)

官网解释

每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。 但也可以使用任意的输入流（InputStream）实例，比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，使得从类路径或其它位置加载资源文件更加容易。

Mybatis核心配置文件

<?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="jdbc.properties"/>

    <!--日志设置-->
    <settings>
        <!--全局性地开启或关闭所有映射器配置文件中已配置的任何缓存-->
        <setting name="cacheEnabled" value="true"/>
        <!--标准的日志工厂的实现-->
        <setting name="logImpl" value="LOG4J"/>
        <!--是否开启驼峰命名自动映射-->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
    <!--配置别名-->
    <typeAliases>
<!--        <typeAlias type="com.zjx.pojo.User" alias="User"/>-->
        <package name="com.zjx.pojo"/>
    </typeAliases>

    <!-- 配置开发环境，可以配置多个，在具体用时再做切换 -->
    <environments default="test">
        <environment id="test">
            <transactionManager type="JDBC"></transactionManager>    <!-- 事务管理类型：JDBC、MANAGED -->
            <dataSource type="POOLED">    <!-- 数据源类型：POOLED、UNPOOLED、JNDI -->
                <property name="driver" value="${driver}" />
                <property name="url" value="${url}" />
                <property name="username" value="${username}" />
                <property name="password" value="${password}" />
            </dataSource>
        </environment>
    </environments>

    <!-- 加载映射文件 mapper -->
    <mappers>
        <mapper resource="com/zjx/dao/UserMapper.xml"/>
        <mapper resource="com/zjx/dao/TeacherMapper.xml"/>
        <mapper resource="com/zjx/dao/BlogMapper.xml"/>
    </mappers>
</configuration>

当然，还有很多可以在 XML 文件中配置的选项，上面的示例仅罗列了最关键的部分。 注意 XML 头部的声明，它用来验证 XML 文档的正确性。environment 元素体中包含了事务管理和连接池的配置。mappers 元素则包含了一组映射器（mapper），这些映射器的 XML 映射文件包含了 SQL 代码和映射定义信息。

获取SQLSessionFactory实例

//加载配置文件
InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
//从配置文件中构建SqlSessionFactory 实例
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

3.从 SqlSessionFactory 中获取 SqlSession

通过Mybatis核心配置文件，我们就有了SqlSessionFactory实例，通过该实例我们可以获取到SQLSession实例

SqlSession session = sqlSessionFactory.openSession();

SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。例如：

Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);

诚然，这种方式能够正常工作，对使用旧版本 MyBatis 的用户来说也比较熟悉。但现在有了一种更简洁的方式——使用和指定语句的参数和返回值相匹配的接口（比如 BlogMapper.class），现在你的代码不仅更清晰，更加类型安全，还不用担心可能出错的字符串字面值以及强制类型转换。

BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);

4.探究已映射的SQL语句

这里给出一个基于 XML 映射语句的示例，它应该可以满足上个示例中 SqlSession 的调用

<?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="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

Mybatis学习--入门

你可能会注意到，这种方式和用全限定名调用 Java 对象的方法类似。这样，该命名就可以直接映射到在命名空间中同名的映射器类，并将已映射的 select 语句匹配到对应名称、参数和返回类型的方法。因此你就可以像上面那样，不费吹灰之力地在对应的映射器接口调用方法，就像下面这样：

BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);

对名称空间的一点补充

命名空间的作用有两个，一个是利用更长的全限定名来将不同的语句隔离开来，同时也实现了你上面见到的接口绑定。就算你觉得暂时用不到接口绑定，你也应该遵循这里的规定，以防哪天你改变了主意。 长远来看，只要将命名空间置于合适的 Java 包命名空间之中，你的代码会变得更加整洁，也有利于你更方便地使用 MyBatis。

命名解析

**命名解析：**为了减少输入量，MyBatis 对所有具有名称的配置元素（包括语句，结果映射，缓存等）使用了如下的命名解析规则。

  • 全限定名（比如 “com.mypackage.MyMapper.selectAllThings）将被直接用于查找及使用。
  • 短名称（比如 “selectAllThings”）如果全局唯一也可以作为一个单独的引用。 如果不唯一，有两个或两个以上的相同名称（比如 “com.foo.selectAllThings” 和 “com.bar.selectAllThings”），那么使用时就会产生“短名称不唯一”的错误，这种情况下就必须使用全限定名。

基于注解的语句映射

package org.mybatis.example;
public interface BlogMapper {
  @Select("SELECT * FROM blog WHERE id = #{id}")
  Blog selectBlog(int id);
}

使用注解来映射简单语句会使代码显得更加简洁，但对于稍微复杂一点的语句，Java 注解不仅力不从心，还会让你本就复杂的 SQL 语句更加混乱不堪。 因此，如果你需要做一些很复杂的操作，最好用 XML 来映射语句。

选择何种方式来配置映射，以及认为是否应该要统一映射语句定义的形式，完全取决于你和你的团队。 换句话说，永远不要拘泥于一种方式，你可以很轻松的在基于注解和 XML 的语句映射方式间*移植和切换。

5.作用域和生命周期

理解我们之前讨论过的不同作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题。

**提示：**对象生命周期和依赖注入框架

依赖注入框架可以创建线程安全的、基于事务的 SqlSession 和映射器，并将它们直接注入到你的 bean 中，因此可以直接忽略它们的生命周期。 如果对如何通过依赖注入框架使用 MyBatis 感兴趣，可以研究一下 MyBatis-Spring 或 MyBatis-Guice 两个子项目。

SqlSessionFactoryBuilder

这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。

SqlSessionFactory

SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。 下面的示例就是一个确保 SqlSession 关闭的标准模式：

//所有代码中都遵循这种使用模式，可以保证所有数据库资源都能被正确地关闭。
try (SqlSession session = sqlSessionFactory.openSession()) {
  // 你的应用逻辑代码
}

6.映射器实例

映射器是一些绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。虽然从技术层面上来讲，任何映射器实例的最大作用域与请求它们的 SqlSession 相同。但方法作用域才是映射器实例的最合适的作用域。 也就是说，映射器实例应该在调用它们的方法中被获取，使用完毕之后即可丢弃。 映射器实例并不需要被显式地关闭。尽管在整个请求作用域保留映射器实例不会有什么问题，但是你很快会发现，在这个作用域上管理太多像 SqlSession 的资源会让你忙不过来。 因此，最好将映射器放在方法作用域内。就像下面的例子一样：

try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // 你的应用逻辑代码
}

7.结合IDEA总结一下Mybatis的使用

7.1项目工程目录

Mybatis学习--入门

7.2我们从测试类开始往下说

public void test7() {
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        BlogMapper mapper = sqlSession.getMapper(BlogMapper.class);

        Map map = new HashMap();
        map.put("author", "zjx");
        List<Blog> blogBy = mapper.getBlogBy(map);
        blogBy.forEach(System.out::println);

        sqlSession.close();

        SqlSession sqlSession1 = MybatisUtils.getSqlSession();
        BlogMapper mapper1 = sqlSession1.getMapper(BlogMapper.class);
        List<Blog> blogBy1 = mapper1.getBlogBy(map);
        blogBy1.forEach(System.out::println);
        sqlSession1.close();
    }

7.21 获取sqlSession实例（我们上面提到过）

MybatisUtils

public class MybatisUtils {
    static private SqlSessionFactory sqlSessionFactory;
    static {
        InputStream inputStream = null;
        try {
            inputStream = Resources.getResourceAsStream("mybatis-config.xml");
        } catch (IOException e) {
            e.printStackTrace();
        }
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }
    static public SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }

7.22 解释sqlSession.getMapper(BlogMapper.class)

我们能通过BlogMapper.class获得BlogMapper对象是因为我们在BlogMapper类中使用了@Alias注解，这和在mybatis-config.xml中使用typeAliases标签的效果是一样的，详细内容请参考：点我不会让你失望

7.23 解释 List blogBy = mapper.getBlogBy(map)

BlogMapper

@Alias("blogMapper")
public interface BlogMapper {

    /**
     * 通过map的值去查询相关数据
     * @param map
     * @return
     */
    public List<Blog> getBlogBy(Map map);

    public List<Blog> getByWhere(Map map);

    public void updateBySet(Map map);

    public List<Blog> testIn(ArrayList<String> list);


}

BlogMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zjx.dao.BlogMapper">

    <!--开启二级缓存-->
    <cache/>
    <select id="getBlogBy" parameterType="map" resultType="Blog">
        select * from blog
        where 1=1
        <if test="title != null">
            and title = #{title}
        </if>
        <if test="author != null">
            and author = #{author}
        </if>
        <if test="views != null">
            and views > #{views}
        </if>
    </select>
    <select id="getByWhere" resultType="Blog">
        select * from Blog
        <trim prefix="WHERE" prefixOverrides="AND |OR ">
            <if test="author">
                author = #{author}
            </if>
            <if test="title">
                and title = #{title}
            </if>
            <if test="views">
                and views > #{views}
            </if>
        </trim>
    </select>

    <update id="updateBySet" parameterType="map">
        update blog
        <trim prefix="set" suffixOverrides=",">
            <if test="author != null">
                author = #{myauthor},
            </if>
            <if test="views != null">
                views = #{views},
            </if>
        </trim>
        where author = #{author}
    </update>

    <select id="testIn" parameterType="arraylist" resultType="Blog">
        select * from Blog
        where author in
        <foreach collection="list" item="author" open="(" separator="," close=")">
            #{author}
        </foreach>
    </select>
</mapper>

BlogMapper.java和BlogMapper.xml是通过命名空间联系起来的

总结一下

上面的大部分内容都是Mybatis官网上的，更多详细内容小伙伴们可以去官网查阅，之前学Mybatis的时候看的是B站狂神老师的视频，看完觉得Mybatis还可以，用起来不是很难，但过一段时间就发现自己好多原理性的东西都不了解（现在也是，但是现在不打算深究了，现在先用起来，用熟练了在回来研究一下），这次是总结一下，梳理一下自己以前没注意到的地方。

上一篇：Mybatis源码分析(1)之mybatis入门使用


下一篇：MyBatis-生命周期