欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

【跟着官网学】mybatis-001 :入门

程序员文章站 2022-05-24 15:41:55
...

本文参考官网地址:点我直达


这是【跟着官网学】mybatis的第一篇文章。

示例的源码:GitHub

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

【跟着官网学】mybatis-001 :入门

一、XML配置

XML 配置文件中包含了对 MyBatis 系统的核心设置,包括获取数据库连接实例的数据源(DataSource)以及决定事务作用域和控制方式的事务管理器(TransactionManager)。这里先给出一个简单的示例:

(代码部分并非完全照搬官网,自己多动手,多理解)

<?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>
        <property name="driver" value="com.mysql.cj.jdbc.Driver" />
        <property name="url" value="jdbc:mysql://172.16.135.3:3306/aranDB?characterEncoding=UTF-8&amp;useSSL=false&amp;serverTimezone=Asia/Shanghai" />
        <property name="username" value="root" />
        <property name="password" value="root" />
    </properties>
    <settings>
        <!-- 开启驼峰命名转换 -->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
    <typeAliases>
        <typeAlias alias="User" type="me.learn.mybatis.pojo.User"/>
    </typeAliases>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="mappers/userMapper.xml"/>
     </mappers>
    <!-- 配置全局属性 -->



</configuration>

可能聪明的你,也注意到了,文件中引入了一个“userMapper.xml”,它就是传说中的Mapper,具体的映射处理都在Mapper文件中实现了,下面给出简单的userMapper.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="me.learn.mybatis.mapper.UserMapper">
    <select id="getUserById" resultType="User">
    select * from User where id = #{id}
     </select>
</mapper>

不使用 XML 构建 SqlSessionFactory 部分暂不谈论,就是这么任性

二、得到SqlSession

按照图中的流程,想得到SqlSession,就先要得到SqlSessionFactoryBuilder,用它读取XML,mybatis提供一个 Resources 类,可以将XML读入输入流中:

  String resource = "mybatis-cfg.xml";
  InputStream in = Resources.getResourceAsStream(resource);

这样,我们就得到XML文件中的配置(原材料),那么,怎么用呢,想要得到产品(SqlSession),你得有工厂(SqlSessionFactory),你想有工厂,那得有建筑公司(SqlSessionFactoryBuilder),所以,我们要通过建筑公司使用原材料,来建工厂吧,于是:

 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);

这样,我们就得到了工厂,那工厂有了,就可以制造产品了:

SqlSession session = sqlSessionFactory.openSession()

有了产品,我们就可以使用产品了(两种方式):

  User user = (User) session.selectOne("me.learn.mybatis.mapper.UserMapper.getUserById", 101);
  System.out.println(user.toString());
  System.out.println("=================================");
  UserMapper userMapper = session.getMapper(UserMapper.class);
  System.out.println(userMapper.getUserById(101));

以下是主方法的完整代码(部分注释内容值得学习):

package me.learn.mybatis;
import me.learn.mybatis.mapper.UserMapper;
import me.learn.mybatis.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;
import java.sql.SQLException;

/**
 * @Author Aran
 * @Date 2020/11/28 下午4:29
 */
public class App {
    public static void main(String[] args) throws Exception {
        //1. 读取 xml
        String resource = "mybatis-cfg.xml";
        InputStream in = Resources.getResourceAsStream(resource);
        //2. 得到SqlSessionFactory
        /*
        * SqlSessionFactoryBuilder
        * 这个类可以被实例化、使用和丢弃,一旦创建了 SqlSessionFactory,就不再需要它了。
        * 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域(也就是局部方法变量)。
        * 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例,
        * 但最好还是不要一直保留着它,以保证所有的 XML 解析资源可以被释放给更重要的事情。
        * */
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
        //3. 得到SqlSession
        /**
         * SqlSessionFactory
         *
         * SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。
         * 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次,
         * 多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。
         * 有很多方法可以做到,最简单的就是使用单例模式或者静态单例模式。
         */

        /**
         * SqlSession
         *
         * 每个线程都应该有它自己的 SqlSession 实例。
         * SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。
         * 绝对不能将 SqlSession 实例的引用放在一个类的静态域,甚至一个类的实例变量也不行。
         * 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中,比如 Servlet 框架中的 HttpSession。
         * 如果你现在正在使用一种 Web 框架,考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。
         * 换句话说,每次收到 HTTP 请求,就可以打开一个 SqlSession,返回一个响应后,就关闭它。
         * 这个关闭操作很重要,为了确保每次都能执行关闭操作,你应该把这个关闭操作放到 finally 块中。
         * 下面的示例就是一个确保 SqlSession 关闭的标准模式:
         */
        try (SqlSession session = sqlSessionFactory.openSession()) {
            User user = (User) session.selectOne("me.learn.mybatis.mapper.UserMapper.getUserById", 101);
            System.out.println(user.toString());
            System.out.println("=================================");
            UserMapper userMapper = session.getMapper(UserMapper.class);
            System.out.println(userMapper.getUserById(101));
        }



     }
}

别犹豫,运行它:

User{id=101, userName='Aran'}
=================================
User{id=101, userName='Aran'}

愚昧无知是一切痛苦之源
——尼采