七、MyBatis的核心配置

最新推荐文章于 2024-06-20 15:13:50 发布

饭团煲

最新推荐文章于 2024-06-20 15:13:50 发布

阅读量753

点赞数

分类专栏： SSM 文章标签： mybatis java 开发语言 eclipse

本文链接：https://blog.csdn.net/m0_62639288/article/details/131570038

版权

SSM 专栏收录该内容

27 篇文章 1 订阅

订阅专栏

一、 MyBatis的核心对象

在使用MyBatis框架时，主要涉及两个核心对象:SqlSessionFactory和 SqlSession，它们在MyBatis框架中起着至关重要的作用。

1、SqlSessionFactory

（1）什么是SqlSessionFactory?

SqlSessionFactory是MyBatis框架中十分重要的对象，它是单个数据库映射关系经过编译后的内存镜像，其主要作用是创建SqlSession。
SqlSessionFactory对象的实例可以通过SqlSessionFactoryBuilder对象来构建，而SqlSessionFactoryBuilder则可以通过XML配置文件或一个预先定义好的Configuration实例构建出SqlSessionFactory的实例。

（2）构建SqlSessionFactory

通过XML配置文件构建出的SqlSessionFactory实例现代码如下：

InputStream inputStream = Resources.getResourceAsStream("配置文件位置"); SqlSessionFactory sqlSessionFactory =

new SqlSessionFactoryBuilder().build(inputStream);

SqlSessionFactory对象是线程安全的，它一旦被创建，在整个应用执行期间都会存在。如果我们多次的创建同一个数据库的SqlSessionFactory，那么此数据库的资源将很容易被耗尽。为此，通常每一个数据库都会只对应一个SqlSessionFactory，所以在构建SqlSessionFactory实例时，建议使用单例模式。

2、SqlSession

（1）什么是SqlSession?

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

每一个线程都应该有一个自己的 SqlSession实例，并且该实例是不能被共享的。同时，SqlSession实例也是线程不安全的，因此其使用范围最好在一次请求或一个方法中，绝不能将其放在一个类的静态字段、实例字段或任何类型的管理范围（如 Servlet的 HttpSession )中使用。使用完SqlSession对象之后，要及时地关闭它，通常可以将其放在finally块中关闭，代码如下所示。

SqlSession sqlSession = sqlSessionFactory.openSession();

try {

// 此处执行持久化操作

} finally {

sqlSession.close();

}

（2）SqlSession中的方法

查询方法：

<T> T selectOne(String statement);查询方法。参数 statement是在配置文件中定义的<select>元素的id。使用该方法后，会返回执行SQL语句查询结果的一条泛型对象。
<T> T selectOne(String statement, Object parameter);查询方法。参数statement是在配置文件中定义的<select>元素的id，parameter是查询所需的参数。使用该方法后，会返回执行SQL语句查询结果的一条泛型对象。
<E> List<E> selectList(String statement);查询方法。参数statement是在配置文件中定义的<select>元素的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是在配置文件中定义的<delete>元素的id。使用该方法后，会返回执行SQL语句所影响的行数。
int delete(String statement, Object parameter);删除方法。参数statement是在配置文件中定义的<delete>元素的id，parameter是删除所需的参数。使用该方法后，会返回执行SQL语句所影响的行数。

其他方法：

void commit(); 提交事务的方法。
void rollback(); 回滚事务的方法。
void close(); 关闭SqlSession对象。
<T> T getMapper(Class<T> type); 该方法会返回Mapper接口的代理对象，该对象关联了SqlSession对象，开发人员可以使用该对象直接调用方法操作数据库。参数 type是 Mapper 的接口类型。MyBatis 官方推荐通过Mapper对象访问MyBatis。

Connection getConnection(); 获取JDBC数据库连接对象的方法。

3、使用工具类创建SqlSession

在上一章的入门案例中，每个方法执行时都需要读取配置文件，并根据配置文件的信息构建SqISessionFactory对象，然后创建SqISession对象，这导致了大量的重复代码。为了简化开发，我们可以将上述重复代码封装到一个工具类中，然后通过工具类来创建SqISession

/**
*工具类
*/
public class MybatisUtils {
private static SqlSessionFactory sqlSessionFactory = null;
//初始化SqlSessionFactory对象
static {
try {
   //使用MyBatis提供的Resources类加载MyBatis的配置文件Reader
      Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
       //构建SqlSessionFactory工厂
      sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
} catch (Exception e) {
      e.printStackTrace();
}
}
   //获取Sqlsession对象的静态方法
public static SqlSession getSession() {
return sqlSessionFactory.openSession();
}
}

这样，我们在使用时就只创建了一个SqISessionFactory对象，并且可以通过工具类的getSession()方法，来获取SqlSession对象。

二、配置文件

1 、主要元素

在MyBatis框架的核心配置文件中，<configuration>元素是配置文件的根元素，其他元素都要在<configuration>元素内配置。

2、<properties>元素

<properties>是一个配置属性的元素，该元素通常用来将内部的配置外在化，即通过外部的配置来动态的替换内部定义的属性。例如，数据库的连接等属性，就可以通过典型的Java属性文件中的配置来替换，具体方式如下：

( 1)在项目的src目录下，添加一个全名为db.properties的配置文件，编辑后的代码如下所示。

【注意空格问题】

jdbc.driver=com.mysql.jdbc.Driver

jdbc.url=jdbc:mysql://localhost:3306/mybatis

jdbc.username=root

jdbc.password=root

(2）在 MyBatis 配置文件mybatis-config.xml中配置<properties..../>属性，具体如下。

<properties resource="db.properties" />

（3）修改配置文件中数据库连接的信息

<dataSource type="POOLED">

<property name="driver" value="${jdbc.driver}" />

<property name="url" value="${jdbc.url}" />

<property name="username" value="${jdbc.username}" />

<property name="password" value="${jdbc.password}" />
</dataSource>

完成上述配置后, dataSource中连接数据库的4个属性( driver . url. username和password )值将会由db.properties文件中对应的值来动态替换。这样就为配置提供了诸多灵活的选择。

3、<settings>元素

<settings>元素主要用于改变MyBatis运行时的行为，例如开启二级缓存、开启延迟加载等。

<settings>
<setting name=" cacheEnabled" value="true"/>
<setting name="lazyLoadingEnabled" value="true" />
<setting name="multipleResultSetsEnabled" value="true"/><setting name="useColumnLabel" value="true"/>
<setting name="useGeneratedKeys" value="false"/>
<setting name="autoMappingBehavior" value="PARTIAL”>...
</settings>

上面所介绍的配置内容大多数都不需要开发人员去配置它。

4、<typeAliases>元素

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

使用<typeAliases>元素配置别名的方法如下。

（1）

<!--定义别名—->
<typeAliases>
<typeAlias alias="user" type="com.itheima.po.User"/>

</typeAliases>

上述示例中，<typeAliases>元素的子元素<typeAlias>中的 type 属性用于指定需要被定义别名的类的全限定名; alias属性的属性值 user 就是自定义的别名，它可以代替 com.itheima.po.User使用在 MyBatis 文件的任何位置。如果省略 alias 属性，MyBatis 会默认将类名首字母小写后的名称作为别名。

（2）当POJO类过多时，还可以通过自动扫描包的形式自定义别名，具体示例如下。

<typeAliases>
<package name="com.itheima.po"/>

</typeAliases>

上述示例中，<typeAliases>元素的子元素<package>中的name 属性用于指定要被定义别名的包，MyBatis 会将所有com.itheima.po包中的POJO类以首字母小写的非限定类名来作为它的别名，比如 com.itheima.po.User的别名为user，com.itheima.po.Customer的别名为customer等。

（3）需要注意的是，上述方式（1）（2）的别名只适用于没有使用注解的情况。如果在程序中使用了注解,则别名为其注解的值，具体如下。

@Alias (value = "user")

public class User ｛

//User的属性和方法
.··｝

除了可以使用<typeAliases>元素自定义别名外，MyBatis框架还默认为许多常见的Java类型（如数值、字符串、日期和集合等）提供了相应的类型别名，如表7-2所示。

表7-2所列举的别名可以在 MyBatis 中直接使用，但由于别名不区分大小写，所以在使用时要注意重复定义的覆盖问题。

5、<typeHandler>元素

typeHandler的作用就是将预处理语句中传入的参数从javaType（Java类型）转换为jdbcType（JDBC类型），或者从数据库取出结果时将jdbcType转换为javaType。

<typeHandler>元素可以在配置文件中注册自定义的类型处理器，它的使用方式有两种。

1.注册一个类的类型处理器

<typeHandlers>

<typeHandler handler="com.itheima.type.CustomtypeHandler" />

</typeHandlers>

2.注册一个包中所有的类型处理器

<typeHandlers>

<package name="com.itheima.type" />

</typeHandlers>

6、<mappers>元素

<mappers>元素用于指定MyBatis映射文件的位置

（1）使用类路径引入

<mappers>

<mapper resource="com/itheima/mapper/UserMapper.xml"/>

</mappers>

（2）使用包名引入

<mappers>

<package name="com.itheima.mapper"/>

</mappers>

三、映射文件

映射文件是MyBatis框架中十分重要的文件，可以说，MyBatis框架的强大之处就体现在映射文件的编写上。

1、<mapper>元素

在映射文件中，<mapper>元素是映射文件的根元素，其他元素都是它的子元素。

2、<select>元素

<select>元素用来映射查询语句，它可以帮助我们从数据库中读取出数据，并组装数据给业务开发人员。使用<select>元素执行查询操作非常简单，其示例如下：

<select id="findCustomerById" parameterType="Integer"

resultType="com.itheima.po.Customer">

select * from t_customer where id = #{id}

</select>

上述语句中的唯一标识为findCustomerByld，它接收一个Integer类型的参数，并返回一个Customer 类型的对象。
<select>元素中，除了上述示例代码中的几个属性外，还有其他一些可以配置的属性，如表所示。

2、<insert>元素

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

<insert>元素的配置示例如下：

<insert
id="addCustomer"
parameterType="com.itheima.po.Customer"
flushCache="true"
statementType="PREPARED"
keyProperty=""
keyColumn=""
useGeneratedKeys=""
timeout="20">

<insert>元素的属性与<select>元素的属性大部分相同，但还包含了3个特有属性，这3个属性的描述如下所示。

如何获得当前插入信息的ID值？

执行插入操作后，很多时候需要返回插入成功的数据生成的主键值，此时就可以通过上面讲解的3个属性来实现。

1.对于支持主键自助增长的数据库（如MySQL），可以通过如下配置实现：

<insert id="addCustomer" parameterType="com.itheima.po.Customer"
keyProperty="id" useGeneratedKeys="true" >
insert into t_customer(username,jobs,phone)
values(#{username},#{jobs},#{phone})
</insert>

2.对于不支持主键自助增长的数据库(如Oracle)，可以通过如下配置实现：

<insert id="insertCustomer" parameterType="com.itheima.po.Customer">
<selectKey keyProperty="id" resultType="Integer" order="BEFORE">
select if(max(id) is null, 1, max(id) +1) as newId from t_customer
</selectKey>
insert into t_customer(id,username,jobs,phone)
values(#{id},#{username},#{jobs},#{phone})
</insert>

使用上述配置执行插入后，会返回插入成功的行数,以及插入行的主键值。为了验证此配置，可以通过如下代码测试。

@Test
public void addCustomerTest(){
       //获取SqlSession
       SqlSession sqlSession = MybatisUtils.getSession();
       Customer customer = new Customer();
       customer.setUsername("Rose");
       customer.setJobs("student");
       customer.setPhone("13333533092");
       int rows = sqlSession.insert("com.itheima.mapper.CustomerMapper.addCustomer", customer);
       /输出插入数据的主键id值
       System.out.println(customer.getId());
       //5.反馈插入信息
       if(rows>0) {
           System.out.println("您成功插入了"+rows+"条数据");
       }else {
           System.out.println("执行插入操作失败！");
       }
       //提交事务
       sqlSession.commit();
       //6.关闭Sqlsession
       sqlSession.close();
   }

执行程序后，控制台的输出结果如图

3、 <update>和<delete>元素

1.<update>和<delete>元素的常用属性如下：

<update
id="updateCustomer"
parameterType="com.itheima.po.Customer"
flushCache="true"
statementType="PREPARED"
timeout="20">
<delete
id="deleteCustomer"
parameterType="com.itheima.po.Customer"
flushCache="true"
statementType="PREPARED"
timeout="20">

2.<update>和<delete>元素的使用示例如下：

<update id="updateCustomer" parameterType="com.itheima.po.Customer">
update t_customer
set username=#{username},jobs=#{jobs},phone=#{phone}
where id=#{id}
</update>

<delete id="deleteCustomer" parameterType="Integer">
delete from t_customer where id=#{id}
</delete>

4、 <sql>元素

在一个映射文件中，通常需要定义多条SQL语句，这些SQL语句的组成可能有一部分是相同的（如多条select语句中都查询相同的id、username、jobs字段），如果每一个SQL语句都重写一遍相同的部分，势必会增加代码量，导致映射文件过于臃肿。那么有没有什么办法将这些SQL语句中相同的组成部分抽取出来，然后在需要的地方引用呢？

<sql>元素的作用就是定义可重用的SQL代码片段，然后在其他语句中引用这一代码片段。

定义一个包含id、username、jobs和phone字段的代码片段如下：

<sql id="customerColumns">id,username,jobs,phone</sql>

上述代码片段可以包含在其他语句中使用，具体如下：

<select id="findCustomerById" parameterType="Integer"
resultType="com.itheima.po.Customer">
select <include refid="customerColumns"/>
from t_customer
where id = #{id}
</select>

上面示例只是一个简单的引用查询。在实际开发中，可以更加灵活地定义SQL片段，其示例如下。

<sql id="tablename"> ${prefix}customer</sql>

<sql id="someinclude"> from <include refid="${include_target}" /></sql>

<sql id="customerColumns"> id,username,jobs,phone</sql>
<select id="findCustomerById" parameterType="Integer"
resultType="com.itheima.po.Customer">
select select
<include refid="customerColumns"/> id,username,jobs,phone
<include refid="someinclude"> from
<property name="prefix" value="t_" /> t_customer
<property name="include_target" value="tablename" />
</include>
where id = #{id} where id = ?
</select>

5、<resultMap>元素

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

<resultMap type="" id="">
<constructor> 
<idArg/> 
<arg/> 
</constructor>
<id/> 
<result/> 
<association property="" /> 
<collection property="" /> 
<discriminator javaType=""> 
<case value="" /> 
</discriminator>
</resultMap>

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

(1)在 mybatis 数据库中，创建一个t_user表，并插入几条测试数据。

USE mybatis;
CREATE TABLE t_user(
t_id INT PRIMARY KEYAUTO_INCREMENT,
t_name VARCHAR (50),
t_age INT
);
INSERT INTO t_user(t_name, t_age) VALUES ('Lucy',25);
INSERT INTO t_user(t_name,t_age) VALUES('Lili',20);
INSERT INTO t_user(t_name,t_age)VALOES ('Jim',20);

(2)在 com.itheima.po包中，创建持久化类User，并在类中定义id、name和 age属性，以及其getter/setter方法和 toString()方法

public class User {
   //id自增主键
   private Integer id;
   //姓名
   private String name;
   //年龄
   private Integer age;
   public Integer getId() {
       return id;
   }
   public void setId(Integer id) {
       this.id = id;
   }
   public String getName() {
       return name;
   }
   public void setName(String name) {
       this.name = name;
   }
   public Integer getAge() {
       return age;
   }
   public void setAge(Integer age) {
       this.age = age;
   }
   @Override
   public String toString() {
       return "User [id=" + id + ", name=" + name + ", age=" + age + "]";
   }

}

(3）在 com.itheima.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="com.itheima.mapper.UserMapper">

<resultMap type="com.itheima.po.User" id="resultMap">
       <id property="id" column=" t_id"/>
       
       <result property="name" column=" t_name"/>
       <result property="age" column=" t_age"/>
   </resultMap>

   <select id="findAllUser" resultMap="resultMap">
       select * from t_user
   </select>

</mapper>

<resultMap>的子元素<id>和<result>的property属性表示User类的属性名，column属性表示数据表t_user的列名。<select>元素的resultMap属性表示引用上面定义的resultMap。
( 4）在配置文件mybatis-config.xml中，引入 UserMapper.xml。

(5）在测试类中，编写测试方法findAllUserTest()，代码如下所示。

@Test
   public void findAllUser() {

        SqlSession sqlSession = MybatisUtils.getSession();
       List<User> users=sqlSession.selectList("com.itheima.mapper.UserMapper.findAllUser");
       for(User user:users) {
           System.out.println(user);
       }
       sqlSession.close();
   }

使用JUnit4执行上述方法后,控制台的输出结果

饭团煲

关注

0
点赞
踩
4

收藏

觉得还不错? 一键收藏
1
评论
七、MyBatis的核心配置

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

扫一扫

专栏目录