SqlSessionTemplate使用详解

发布时间：2023-05-17

一、SqlSessionTemplate简介

SqlSessionTemplate是MyBatis-Spring的核心之一。它使用了Spring的SqlSession工厂来创建SqlSession，Spring的SqlSession工厂是使用MyBatis的SqlSessionFactory来创建SqlSession的。 SqlSessionTemplate是线程安全的，同时它也管理着SqlSession的生命周期，和SqlSession的关闭。

二、SqlSessionTemplate的优点

SqlSessionTemplate的优点主要体现在以下几个方面：

1、代码简洁

SqlSessionTemplate将SqlSession的使用封装在了一个类中，我们只需要调用SqlSessionTemplate的方法就可以使用SqlSession了，不用关心SqlSession的创建和关闭。

2、线程安全

SqlSessionTemplate是线程安全的，因为它是通过Spring的SqlSession工厂来创建SqlSession的，SqlSessionTemplate本身是没有状态的。

3、统一管理SqlSession的生命周期

SqlSessionTemplate管理着SqlSession的生命周期，它会自动为我们关闭SqlSession。这样，我们就不用担心在代码中忘记关闭SqlSession的问题了。

三、SqlSessionTemplate的常用方法

SqlSessionTemplate提供了一系列的方法，这里选择了其中的一部分作为例子进行介绍。

1、insert

insert方法可以插入一条记录到数据库中，使用方式如下：

public int insert(String statement, Object parameter) throws DataAccessException {
    return this.sqlSession.insert(statement, parameter);
}

参数说明：

  • statement：指定要执行的SQL语句。
  • parameter：传入的参数，可以是一个对象或Map。

2、selectOne

selectOne方法可以查询一条记录，使用方式如下：

public <T> T selectOne(String statement) throws DataAccessException {
    return this.sqlSession.selectOne(statement);
}
public <T> T selectOne(String statement, Object parameter) throws DataAccessException {
    return this.sqlSession.selectOne(statement, parameter);
}

参数说明：

  • statement：指定要执行的SQL语句。
  • parameter：传入的参数，可以是一个对象或Map。

3、update

update方法可以更新一条记录，使用方式如下：

public int update(String statement, Object parameter) throws DataAccessException {
    return this.sqlSession.update(statement, parameter);
}

参数说明：

  • statement：指定要执行的SQL语句。
  • parameter：传入的参数，可以是一个对象或Map。

4、delete

delete方法可以删除一条记录，使用方式如下：

public int delete(String statement, Object parameter) throws DataAccessException {
    return this.sqlSession.delete(statement, parameter);
}

参数说明：

  • statement：指定要执行的SQL语句。
  • parameter：传入的参数，可以是一个对象或Map。

四、完整代码示例

1、SqlMapConfig.xml配置文件

<?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>
    <!-- 配置数据源 -->
    <dataSource type="com.alibaba.druid.pool.DruidDataSource">
        <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=UTF-8"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
    </dataSource>
    <!-- 配置SqlSession工厂 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="mapperLocations" value="classpath:mapper/*.xml"/>
    </bean>
    <!-- 配置SqlSessionTemplate -->
    <bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
        <constructor-arg index="0" ref="sqlSessionFactory"/>
    </bean>
    <!-- 配置Mapper的扫描 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.example.mapper"/>
    </bean>
</configuration>

2、使用SqlSessionTemplate进行数据库操作的代码

@Repository
public class UserDao {
    @Autowired
    private SqlSessionTemplate sqlSessionTemplate;
    public int addUser(User user) {
        return sqlSessionTemplate.insert("addUser", user);
    }
    public User getUserById(int id) {
        return sqlSessionTemplate.selectOne("getUserById", id);
    }
    public List<User> getAllUser() {
        return sqlSessionTemplate.selectList("getAllUser");
    }
    public int updateUser(User user) {
        return sqlSessionTemplate.update("updateUser", user);
    }
    public int deleteUser(int id) {
        return sqlSessionTemplate.delete("deleteUser", id);
    }
}

3、Mapper.xml文件

<mapper namespace="com.example.mapper.UserMapper">
    <!-- 添加用户 -->
    <insert id="addUser" parameterType="com.example.pojo.User">
        insert into user(id, username, password) values(#{id}, #{username}, #{password})
    </insert>
    <!-- 根据id查询用户 -->
    <select id="getUserById" parameterType="int" resultType="com.example.pojo.User">
        select * from user where id = #{id}
    </select>
    <!-- 查询所有用户 -->
    <select id="getAllUser" resultType="com.example.pojo.User">
        select * from user
    </select>
    <!-- 更新用户 -->
    <update id="updateUser" parameterType="com.example.pojo.User">
        update user set username = #{username}, password = #{password} where id = #{id}
    </update>
    <!-- 根据id删除用户 -->
    <delete id="deleteUser" parameterType="int">
        delete from user where id = #{id}
    </delete>
</mapper>
推荐文章