07. MyBatis的核心配置

最新推荐文章于 2024-10-28 19:09:11 发布

Caris.

最新推荐文章于 2024-10-28 19:09:11 发布

阅读量501

点赞数 1

CC 4.0 BY-SA版权

分类专栏： # SSM 文章标签： mybatis java

本文链接：https://blog.youkuaiyun.com/qq_39666910/article/details/104364746

SSM 专栏收录该内容

18 篇文章

订阅专栏

MyBatis核心配置

1. MyBatis的核心对象
2 配置文件
3. 映射文件

1. MyBatis的核心对象

MyBatis框架主要涉及两个核心对象：SqlSessionFactory和SqlSession

在06. Mybatis概述中的代码可以看出，在使用的时候总离不开五个步骤

读取配置文件
根据配置文件构建SqlSessionFactory
通过SqlSessionFactory创建SqlSession
使用SqlSession对象操作数据库（包括查询、添加、修改、删除以及提交事务等）
关闭SqlSession

大多时候，前三步的代码总是重复的

1.1 SqlSessionFactory

SqlSessionFactory是MyBatis框架中十分重要的对象，它是单个数据库映射关系经过编译后的内存镜像，其主要作用是创建SqlSession。

SqlSessionFactory对象的实例可以通过SqlSessionFactoryBuilder对象来构建，而SqlSessionFactoryBuilder则可以通过XML配置文件或一个预先定义好的Configuration实例构建出SqlSessionFactory的实例。

1.通过xml文件构造SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = 
                new SqlSessionFactoryBuilder().build(inputStream);

SqlSessionFactory对象是线程安全的，它一旦被创建，在整个应用执行期间都会存在
通常每一个数据库都会只对应一个SqlSessionFactory，所以在构建SqlSessionFactory实例时，建议使用单列模式

1.2 SqlSession

SqlSession是MyBatis框架中另一个重要的对象，它是应用程序与持久层之间执行交互操作的一个单线程对象，其主要作用是执行持久化操作
SqlSession对象包含了数据库中所有执行SQL操作的方法，由于其底层封装了JDBC连接，所以可以直接使用其实例来执行已映射的SQL语句

使用完SqlSession对象之后，要及时地关闭它，通常可以将其放在finally块中关闭。

1.示例代码
SqlSession sqlSession = sqlSessionFactory.openSession();
try{
	//进行持久化操作
}finally{
	//在这个关闭sqlSession
}

SqlSession对象常用方法

< T> T selectOne（String statement）
查询方法。参数statement是在配置文件中定义的元素的id。使用该方法后，会返回执行SQL语句查询结果的一条泛型对象
< T> T selectOne（String statement, Object parameter）
查询方法。参数statement是在配置文件中定义的元素的id, parameter是查询所需的参数。使用该方法后，会返回执行SQL语句查询结果的一条泛型对象
< E> List selectList（String statement）
查询方法。参数statement是在配置文件中定义的元素的id。使用该方法后，会返回执行SQL语句查询结果的泛型对象的集合
< E> List< E> selectList（String statement, Object parameter）
查询方法。参数statement是在配置文件中定义的< select>元素的id, parameter是查询所需的参数。使用该方法后，会返回执行SQL语句查询结果的泛型对象的集合
< E> List< E> selectList（String statement, Object parameter, RowBounds rowBounds）
查询方法。参数statement是在配置文件中定义的< select>元素的id, parameter是查询所需的参数，rowBounds是用于分页的参数对象。使用该方法后，会返回执行SQL语句查询结果的泛型对象的集合
void select（String statement, Object parameter, ResultHandler handler）
查询方法。参数statement是在配置文件中定义的< select>元素的id, parameter是查询所需的参数，ResultHandler对象用于处理查询返回的复杂结果集，通常用于多表查询
int insert（String statement）
插入方法。参数statement是在配置文件中定义的< insert>元素的id。使用该方法后，会返回执行SQL语句所影响的行数
int insert（String statement, Object parameter）
插入方法。参数statement是在配置文件中定义的< insert>元素的id, parameter是插入所需的参数。使用该方法后，会返回执行SQL语句所影响的行数。
int update（String statement）
更新方法。参数statement是在配置文件中定义的< update>元素的id。使用该方法后，会返回执行SQL语句所影响的行数。
int update（String statement, Object parameter）
更新方法。参数statement是在配置文件中定义的< update>元素的id, parameter是更新所需的参数。使用该方法后，会返回执行SQL语句所影响的行数。
int delete（String statement）
删除方法。参数statement是在配置文件中定义的元素的id。使用该方法后，会返回执行SQL语句所影响的行数。
int delete（String statement, Object parameter）
删除方法。参数statement是在配置文件中定义的元素的id, parameter是删除所需的参数。使用该方法后，会返回执行SQL语句所影响的行数。
void commit()
提交事务的方法。
void rollback()
回滚事务的方法。
void close()
关闭SqlSession对象

1.3 静态工具类方法

可以减少代码冗余

public class MyBatisUtils {
    private static SqlSessionFactory sqlSessionFactory = null;
    // 初始化SqlSessionFactory对象
    static {
        try {
            // 使用MyBatis提供的Resources类加载MyBatis的配置文件
            Reader reader = 
                    Resources.getResourceAsReader("mybatis-config.xml");
            // 构建SqlSessionFactory工厂
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }    
    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}

2 配置文件

MyBatis的核心配置文件中，包含了很多影响MyBatis行为的重要信息。这些信息通常在一个项目中只会在一个配置文件中编写，并且编写后也不会轻易改动

在MyBatis框架的核心配置文件中，< configuration>元素是配置文件的根元素，其他元素都要在< configuration>元素内配置
在这里插入图片描述
< configuration>的子元素必须按照图中由上到下的顺序进行配置，否则MyBatis在解析XML配置文件的时候会报错

2.1 < properties>

配置属性的元素，该元素通常用于将内部的配置外在化，即通过外部的配置来动态地替换内部定义的属性

1.db.properties文件配置
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306/mybatis?useUnicode=true&characterEncoding=utf-8
username=Caris
password=123456
2.mybatis-config文件配置
<properties resource="db.properties"></properties>
...
	<dataSource type="POOLED">
		<property name="driver" value="${driver}" />
		<property name="url" value="${url}" />
		<property name="username" value="${username}" />
		<property name="password" value="${password}" />
	</dataSource>
...

2.2 < settings>元素

主要用于改变MyBatis运行时的行为，例如开启二级缓存、开启延迟加载等
在这里插入图片描述

//放在properties后面
<settings>
    <setting name="" value=""/>
</settings>

2.3 < typeAliases>元素

< typeAliases>元素用于为配置文件中的Java类型设置一个简短的名字，即设置别名。别名的设置与XML配置相关，其使用的意义在于减少全限定类名的冗余

1.单独设置别名
<typeAliases>
    <typeAlias alias="" type=""/>
</typeAliases>
2.自动包扫描
//当POJO类过多时，还可以通过自动扫描包的形式自定义别名，具体示例如下
<typeAliases>
    <package name=""/>
</typeAliases>

需要注意的是，上述方式的别名只适用于没有使用注解的情况。如果在程序中使用了注解，则别名为其注解的值

//注解方式使用别名
@Alias(value="user")
public class User{
	//User的属性和方法
}

除了可以使用< typeAliases>元素自定义别名外，MyBatis框架还默认为许多常见的Java类型（如数值、字符串、日期和集合等）提供了相应的类型别名
在这里插入图片描述

2.4 < typeHandler>元素

MyBatis在预处理语句（PreparedStatement）中设置一个参数或者从结果集（ResultSet）中取出一个值时，都会用其框架内部注册了的typeHandler（类型处理器）进行相关处理。typeHandler的作用就是将预处理语句中传入的参数从javaType（Java类型）转换为jdbcType（JDBC类型），或者从数据库取出结果时将jdbcType转换为javaType

常见的类处理器
在这里插入图片描述
MyBatis框架所提供的这些类型处理器不能够满足需求时，还可以通过自定义的方式对类型处理器进行扩展（自定义类型处理器可以通过实现TypeHandler接口或者继承BaseTypeHandle类来定义）

    <typeHandlers>
        <typeHandler handler=""/> //注册一个类的类型处理器
        <package name=""/> //注册一个包中所有的类的类型处理器
    </typeHandlers>

2.5 < objectFactory>元素

MyBatis框架每次创建结果对象的新实例时，都会使用一个对象工厂（ObjectFactory）的实例来完成。MyBatis中默认的ObjectFactory的作用就是实例化目标类，它既可以通过默认构造方法实例化，也可以在参数映射存在的时候通过参数构造方法来实例化
在通常情况下，我们使用默认的ObjectFactory即可，MyBatis中默认的ObjectFactory是由org.apache.ibatis.reflection.factory.DefaultObjectFactory来提供服务的。大部分场景下都不用配置和修改，但如果想覆盖ObjectFactory的默认行为，则可以通过自定义ObjectFactory来实现
了解即可

2.6 < plugins>元素

MyBatis允许在已映射语句执行过程中的某一点进行拦截调用，这种拦截调用是通过插件来实现的。< plugins>元素的作用就是配置用户所开发的插件。如果用户想要进行插件开发，必须要先了解其内部运行原理，因为在试图修改或重写已有方法的行为时，很可能会破坏MyBatis原有的核心模块。
了解即可

2.7 < environments>元素

< environments>元素是环境配置的根元素，它包含一个default属性，该属性用于指定默认的环境ID。< environment>是< environments>元素的子元素，它可以定义多个，其id属性用于表示所定义环境的ID值。在< environment>元素内，包含事务管理和数据源的配置信息，其中< transactionManager>元素用于配置事务管理，它的type属性用于指定事务管理的方式，即使用哪种事务管理器；< dataSource>元素用于配置数据源，它的type属性用于指定使用哪种数据源
在MyBatis中，可以配置两种类型的事务管理器，分别是JDBC和MANAGED

<environments default="mysql">
    <!-- 1.2 配置id为mysql的数据库环境 -->
	<environment id="mysql">
	<!-- 使用JDBC的事务管理 -->
		<transactionManager type="JDBC" />
		<!-- 数据库连接池 -->
		<!-- 可采用写死或者properties文件指定 -->
		<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>

JDBC：此配置直接使用了JDBC的提交和回滚设置，它依赖于从数据源得到的连接来管理事务的作用域。
MANAGED：此配置从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期。在默认情况下，它会关闭连接，但一些容器并不希望这样，为此可以将closeConnection属性设置为false来阻止它默认的关闭行为

如果项目中使用的是Spring+ MyBatis，则没有必要在MyBatis中配置事务管理器，因为实际开发中，会使用Spring自带的管理器来实现事务管理

对于数据源的配置，MyBatis框架提供了UNPOOLED、POOLED和JNDI三种数据源类型

UNPOOLED
配置此数据源类型后，在每次被请求时会打开和关闭连接。它对没有性能要求的简单应用程序是一个很好的选择。
需要配置的五种属性
POOLED
此数据源利用“池”的概念将JDBC连接对象组织起来，避免了在创建新的连接实例时所需要初始化和认证的时间。这种方式使得并发Web应用可以快速地响应请求，是当前流行的处理方式
除了上诉属性，还有一下额外属性
JNDI
此数据源可以在EJB或应用服务器等容器中使用。容器可以集中或在外部配置数据源，然后放置一个JNDI上下文的引用

2.8 < mappers>元素

在配置文件中，元素用于指定MyBatis映射文件的位置，一般可以使用以下4种方法引入映射器文件

	<mappers>
	   <!-- 使用类路径进入 -->
		<mapper resource="com/clarence/mapper/CustomerMapper.xml" />
		<!-- 使用本地文件引入 -->
		<mapper url="file:///d:/com/clarence/mapper/CustomerMapper.xml"/>
		<!-- 使用接口类引入 -->		
		<mapper class="com.clarence.mapper.CustomerMapeer"/>
		<!-- 使用包名引入 -->
		<package name="com.clarence.mapper"/>
	</mappers>

3. 映射文件

映射文件是MyBatis框架中十分重要的文件，可以说，MyBatis框架的强大之处就体现在映射文件的编写上。
在这里插入图片描述

3.1 < select>元素

    <select id="findCustomerById" parameterType="Integer" 
        resultType="com.clarence.po.Customer">    
        select * from t_customer where id = #{id}  
    </select>

上述语句中的唯一标识为findCustomerById，它接收一个Integer类型的参数，并返回一个Customer类型的对象
在这里插入图片描述

3.2 < insert>元素

< insert>元素用于映射插入语句，在执行完元素中定义的SQL语句后，会返回一个表示插入记录数的整数。

 <insert id="addCustomer" parameterType="com.clarence.po.Customer">
        insert into t_customer(username,job,phone) 
        value(#{username},#{job},#{phone})
    </insert>

大部分参数与select相同，以下三个特有参数
在这里插入图片描述

3.3 < update>元素和< delete>元素

< update>和元素的使用比较简单，它们的属性配置也基本相同

<update id="updateCustomer" parameterType="com.clarence.po.Customer">
        update t_customer set
        username = #{username},job=#{job},phone=#{phone}
        where id = #{id}
    </update>
    <delete id="deleteCustomer" parameterType="com.clarence.po.Customer">
        delete from t_customer where id=#{id}
    </delete>

与< insert>元素一样，< update>和< delete>元素在执行完之后，也会返回一个表示影响记录条数的整数

3.4 < sql>元素

在一个映射文件中，通常需要定义多条SQL语句，这些SQL语句的组成可能有一部分是相同的（如多条select语句中都查询相同的id、username、jobs字段）
< sql>元素的作用就是定义可重用的SQL代码片段，然后在其他语句中引用这一代码片段

    <sql id="customesColumns">id,username,job,phone</sql>
    <select id="findCustomerById" parameterType="Integer" 
        resultType="com.clarence.po.Customer">    
        select <include refid="customesColumns" /> 
        from t_customer where id = #{id}  
    </select>

    <sql id="tablename">
       from ${tablename}
    </sql>
    <sql id="OperatById">
        where id = #{id}
    </sql>
    <select id="findCustomerById" parameterType="Integer" 
        resultType="com.clarence.po.Customer">    
        select * 
        <include refid="tablename">
            <property name="tablename" value="t_customer"/>
        </include> 
        <include refid="OperatById"></include>
    </select>

3.5 < resultMap>元素

< resultMap>元素表示结果映射集，是MyBatis中最重要也是最强大的元素。它的主要作用是定义映射规则、级联的更新以及定义类型转化器等

    <resultMap type="" id="">
    <constructor>   <!-- 类在实例化时，注入结果到构造方法中 -->
        <idArg/>      <!-- ID参数；标记结果作为ID -->
        <arg/>      <!-- 注入到构造方法的一个普通结果 -->
    </constructor>
    <id/>       <!-- 指明主键 -->
    <result/>   <!-- 注入到JavaBean属性的普通结果 -->
    <association property=""></association> <!--一对一关联 -->
    <collection property=""></collection>   <!--一对多关联 -->
    <discriminator javaType="">             <!-- 决定使用那个结果映射 -->
        <case value=""></case>              <!-- 基于某些值的结果映射 -->
    </discriminator>    
    </resultMap>

在默认情况下，MyBatis程序在运行时会自动地将查询到的数据与需要返回的对象的属性进行匹配赋值（需要表中的列名与对象的属性名称完全一致）。然而实际开发时，数据表中的列和需要返回的对象的属性可能不会完全一致，这种情况下MyBatis是不会自动赋值的。此时，就可以使用< resultMap>元素进行处理。

1.数据库字段
t_id,t_name,t_age
2.javaBean 属性
id,name,age
3.xml文件配置
    <resultMap type="com.clarence.po.User" id="resultMap">
	<id property="id" column="t_id" />      <!-- 指明主键 -->
    <result property="name" column="t_name"/>   <!-- 注入到JavaBean属性的普通结果 -->
    <result property="age" column="t_age"/>   	<!-- 注入到JavaBean属性的普通结果 -->
    </resultMap>    
    <select id="findAllUser" resultMap="resultMap"></select>

本节无源代码