【Mybatis】(二)接口式编程

本文详细介绍了在MyBatis中使用接口代理模式代替命名空间调用方法的优势,包括如何定义代理接口、配置映射文件及测试方法,避免了命名空间调用的繁琐和错误,提高了代码的可读性和维护性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

以前使用sqlSession通过命名空间调用Mybatis方法时,首先需要用到命名空间+方法id组成的字符串来调用相应的方法。

  • 当参数多于1个的时候,需要将所有参数放到一个Map对象中,通过Map传递多个参数,由于命名空间通常会使用相对较长的、且有一定含义的字符串来作为其值,这样就很难保证我们在代码不出现拼写错误的情况
    使用起来很不方便很容易出错,而且无法避免很多重复的代码。
  • 从selectXXX方法的签名可以看到,它的第二个参数是Object类型,那么如果我们传入的参数类型与映射文件中由parameterType属性指定的类型不一致时,将会出现不可预知的错误
  • 同样,selectXXX方法返回值使用了泛型,我们须确保用于接收其返回值的变量类型与映射文件中属性resultType指定的类型相一致

使用接口调用的方式就可以规避以上风险而且使用起来更加方便,
Mybatis使用java的动态代理可以直接通过接口来调用相应的方法,不需要提供接口的实现类,更不需要在实现类中使用SqlSession通过命名空间间接调用。

定义代理接口

映射文件的命名空间namespace的值配置成接口的全限定名,即接口所在的包名加上接口名称。

XML中的select标签的id属性值和定义的接口的方法名一致,Mybatis就是通过这种方式将接口方法和XML中定义的SQL语句关联到一起。如果不一致,启动程序便会报错。

<?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.lhk.mybatis.dao.EmployeeMapper">
<!-- 
namespace:名称空间;指定为接口的全限定名
id:唯一标识,此时与接口的方法名相对应(getEmpById)
resultType:返回值类型
#{id}:从传递过来的参数中取出id值

public Employee getEmpById(Integer id);
 -->

    <select id="getEmpById" resultType="com.lhk.mybatis.bean.Employee">
        select id,last_name lastName,email,gender from tb1_employee where id = #{id}
    </select>
</mapper> 
定义接口

在代理接口中定义一些方法,并以相应元素的id属性值做为方法名,parameterType属性值做为方法参数类型,属性resultType值做为方法的返回值即可。
接口不需要实现Mybatis会使用动态代理机制来帮助我们完成额外的工作。

package com.lhk.mybatis.dao;

import com.lhk.mybatis.bean.Employee;

public interface EmployeeMapper {

    public Employee getEmpById(Integer id);

}

在Mybatis的全局配置文件(mybatis-config.xml)中,加入如下语句。

<mappers>
        <mapper resource="EmployeeMapper.xml" />
</mappers>
测试方法
package com.lhk.mybatis.test;

import java.io.IOException;
import java.io.InputStream;

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 org.junit.Test;

import com.lhk.mybatis.bean.Employee;
import com.lhk.mybatis.dao.EmployeeMapper;

/**
 * 1、接口式编程
 *  原生:     Dao     ====>  DaoImpl
 *  mybatis:    Mapper  ====>  xxMapper.xml
 * 
 * 2、SqlSession代表和数据库的一次会话;用完必须关闭;
 * 3、SqlSession和connection一样它都是非线程安全。每次使用都应该去获取新的对象。
 * 4、mapper接口没有实现类,但是mybatis会为这个接口生成一个代理对象。
 *      (将接口和xml进行绑定)
 *      EmployeeMapper empMapper =  sqlSession.getMapper(EmployeeMapper.class);
 * 5、两个重要的配置文件:
 *      mybatis的全局配置文件:包含数据库连接池信息,事务管理器信息等...系统运行环境信息
 *      sql映射文件:保存了每一个sql语句的映射信息:
 *                  将sql抽取出来。   
 */
public class MyBatisTest {

    public SqlSessionFactory getSqlSessionFactory() throws IOException {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        return new SqlSessionFactoryBuilder().build(inputStream);
    }

    @Test
    public void test01() throws IOException {
        /* 1、获取sqlSessionFactory对象 */
        SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
        /* 2、获取sqlSession对象 */
        SqlSession openSession = sqlSessionFactory.openSession();
        try {
            /* 3、获取接口的实现类对象 */
            /* 会为接口自动的创建一个代理对象,代理对象去执行增删改查方法 */
            EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);
            Employee employee = mapper.getEmpById(2);
            System.out.println(employee);
        } finally {
            openSession.close();
        }
    }
}
运行结果:

这里写图片描述

MyBatis 本身并不直接支持声明编程,但通过与 Spring 框架的集成,可以实现类似声明编程的效果。Spring 提供了声明事务管理和依赖注入等功能,这些功能可以与 MyBatis 的持久层操作相结合,从而简化数据库操作并提高代码的可维护性。 ### 声明事务管理 在 Spring 中,可以通过注解或 XML 配置来实现声明事务管理。以下是一个简单的示例,展示如何在 Spring 中配置和使用声明事务: #### 1. 配置事务管理器 首先,在 Spring 的配置文件中定义事务管理器。通常使用 `DataSourceTransactionManager`,并将其与数据源关联: ```xml <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <property name="dataSource" ref="dataSource"/> </bean> ``` #### 2. 启用事务注解 接下来,启用事务注解驱动,以便可以在服务层使用 `@Transactional` 注解: ```xml <tx:annotation-driven transaction-manager="transactionManager"/> ``` #### 3. 使用 `@Transactional` 注解 在服务层的方法上使用 `@Transactional` 注解,以声明该方法需要事务管理: ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; @Service public class UserService { @Autowired private UserMapper userMapper; @Transactional public void addUser(User user) { userMapper.insertUser(user); // 其他数据库操作 } } ``` 在这个例子中,`addUser` 方法被标记为事务性方法,Spring 会自动为其开启事务,并在方法执行完成后提交事务。如果方法抛出异常,事务将回滚[^2]。 ### 与 MyBatis 的集成 为了在 MyBatis 中使用 Spring 的声明事务管理,需要确保 MyBatis 的 `SqlSession` 与 Spring 的事务管理器协同工作。可以通过 `SqlSessionFactoryBean` 和 `MapperFactoryBean` 来实现这一点。 #### 1. 配置 `SqlSessionFactoryBean` ```xml <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <property name="configLocation" value="classpath:mybatis-config.xml"/> </bean> ``` #### 2. 配置 Mapper 接口 使用 `MapperFactoryBean` 来创建 MyBatis 的 Mapper 接口实例: ```xml <bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean"> <property name="mapperInterface" value="com.example.mapper.UserMapper"/> <property name="sqlSessionFactory" ref="sqlSessionFactory"/> </bean> ``` #### 3. 使用 Mapper 接口 在服务层中,可以直接注入并使用 Mapper 接口: ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; @Service public class UserService { @Autowired private UserMapper userMapper; @Transactional public void addUser(User user) { userMapper.insertUser(user); // 其他数据库操作 } } ``` 在这个例子中,`UserMapper` 是一个 MyBatis接口,定义了与数据库交互的方法。通过 Spring 的依赖注入,可以直接在服务层中使用这些方法[^4]。 ### 实战开发中的最佳实践 - **事务边界控制**:确保事务的边界清晰,避免在一个事务中执行过多的操作,以减少锁竞争和提高性能。 - **异常处理**:在事务方法中捕获并处理异常,确保在发生错误时能够正确回滚事务。 - **只读事务优化**:对于只读操作,可以使用 `@Transactional(readOnly = true)` 来优化事务行为,减少不必要的写操作。 - **事务传播行为**:根据业务需求选择合适的事务传播行为(如 `PROPAGATION_REQUIRED`, `PROPAGATION_REQUIRES_NEW` 等),以确保事务的正确性和一致性。 通过以上步骤和最佳实践,可以在 MyBatis 中结合 Spring 实现声明编程,从而简化数据库操作并提高代码的可维护性[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值