Mybatis-通用Mapper

本文介绍了如何使用Mybatis-通用Mapper简化数据库操作,包括环境搭建、Mybatis工具类修改、编写Mapper接口以及增删改查的实现。通用Mapper通过继承Mapper接口,自动完成了单表的CRUD操作,大大提高了开发效率。

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

Mybatis-通用Mapper

概念:通用Mapper对MyBatis进行简化的第三方工具包
通用Mapper提供了一个名为Mapper的接口,用于自动完成单表的增删改查操作

public interface UserMapper extends Mapper<User> {
}

1.搭建环境
在这里插入图片描述
2.修改工具类-Mybatis工具类

public class MyBatisUtils {

    // 会话工厂
    private static SqlSessionFactory factory;
    static{
        try {
            // 1.1 加载核心配置文件
            InputStream is = Resources.getResourceAsStream("SqlMapConfig.xml");
            // 1.2 获得工厂
            factory = new SqlSessionFactoryBuilder().build(is);

        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    private static ThreadLocal<SqlSession> local = new ThreadLocal<>();

    /**
     * 获得新会话
     * @return
     */
    private static SqlSession openSession(){
        SqlSession sqlSession = local.get();
        if(sqlSession == null){
            sqlSession = factory.openSession();

            //创建一个MapperHelper
            MapperHelper mapperHelper = new MapperHelper();
            //特殊配置
            Config config = new Config();
            // 设置UUID生成策略
            // 配置UUID生成策略需要使用OGNL表达式
            // 默认值32位长度:@java.util.UUID@randomUUID().toString().replace("-", "")
            //config.setUUID("");
            // 主键自增回写方法,默认值MYSQL,详细说明请看文档
//	        config.setIDENTITY("HSQLDB");
            // 支持方法上的注解
            // 3.3.1版本增加
            config.setEnableMethodAnnotation(true);
            config.setNotEmpty(true);
            // 序列的获取规则,使用{num}格式化参数,默认值为{0}.nextval,针对Oracle
            // 可选参数一共3个,对应0,1,2,分别为SequenceName,ColumnName, PropertyName
            //config.setSeqFormat("NEXT VALUE FOR {0}");
            // 设置全局的catalog,默认为空,如果设置了值,操作表时的sql会是catalog.tablename
            //config.setCatalog("");
            // 设置全局的schema,默认为空,如果设置了值,操作表时的sql会是schema.tablename
            // 如果同时设置了catalog,优先使用catalog.tablename
            //config.setSchema("");
            // 主键自增回写方法执行顺序,默认AFTER,可选值为(BEFORE|AFTER)
            //config.setOrder("AFTER");
            //设置配置
            mapperHelper.setConfig(config);
            // 注册通用tk.mybatis.mapper.common.Mapper接口 - 可以自动注册继承的接口
            mapperHelper.registerMapper(Mapper.class);
            mapperHelper.registerMapper(MySqlMapper.class);
//	        mapperHelper.registerMapper(SqlServerMapper.class);
//	        mapperHelper.registerMapper(IdsMapper.class);
            //配置完成后,执行下面的操作
            mapperHelper.processConfiguration(sqlSession.getConfiguration());


            local.set(sqlSession);
        }
        return sqlSession;
    }

    /**
     * 获得mapper
     * @param clazz
     * @return
     */
    public static <T> T getMapper(Class<T> clazz){
        return openSession().getMapper(clazz);
    }

    /**
     * 释放资源
     */
    public static void close() {
        SqlSession sqlSession = openSession();
        if(sqlSession != null){
            sqlSession.close();
        }
    }

    /**
     * 提交并释放资源
     */
    public static void commitAndclose() {
        SqlSession sqlSession = openSession();
        if(sqlSession != null){
            sqlSession.commit();
            close();
        }
    }

    /**
     * 回滚并释放资源
     */
    public static void rollbackAndclose() {
        SqlSession sqlSession = openSession();
        if(sqlSession != null){
            sqlSession.rollback();
            close();
        }
    }

}

3.编写Mapper

编写接口,继承tk.mybatis.mapper.common.Mapper接口即可

注意:Mapper接口以tk开头

public interface UserMapper2 extends Mapper<User> {
}

4.通过主键查询
确定主键,否则所有字段都是主键
在这里插入图片描述
测试

public class Test13_Mapper {
    @Test
    public void testSelectByPrimaryKey() {
        UserMapper2 userMapper2 = MyBatisUtils.getMapper(UserMapper2.class);
        User user = userMapper2.selectByPrimaryKey("1");
        System.out.println(user);

        MyBatisUtils.commitAndclose();

    }
}

5.查询所有

  public void testSelectAll() {
        UserMapper2 userMapper2 = MyBatisUtils.getMapper(UserMapper2.class);
        List<User> list = userMapper2.selectAll();
        // 打印
        list.forEach(System.out::println);

        MyBatisUtils.commitAndclose();
    }

6.添加

 public void testInsert() {
        UserMapper2 userMapper2 = MyBatisUtils.getMapper(UserMapper2.class);

        User user = new User();
        user.setUid("2");
        user.setUsername("jack");
        user.setPassword("1234");
        user.setName("杰克");
        user.setEmail("itcast_lt@163.com");
        user.setBirthday(new Date());
        user.setSex("男");
        user.setSex("0");

        int result = userMapper2.insert(user);

        // 打印
        System.out.println(result);

        MyBatisUtils.commitAndclose();
    }

7.修改

public void testUpdate() {
        UserMapper2 userMapper2 = MyBatisUtils.getMapper(UserMapper2.class);

        User user = new User();
        user.setUid("2");
        user.setUsername("jack");
        user.setPassword("1234");
        user.setName("杰克");
        user.setEmail("itcast_lt@163.com");
        user.setBirthday(new Date());
        user.setSex("男");
        user.setSex("0");

        int result = userMapper2.updateByPrimaryKey(user);

        // 打印
        System.out.println(result);

        MyBatisUtils.commitAndclose();
    }

8.删除

public void testDelete() {
        UserMapper2 userMapper2 = MyBatisUtils.getMapper(UserMapper2.class);

        int result = userMapper2.deleteByPrimaryKey("2");

        // 打印
        System.out.println(result);

        MyBatisUtils.commitAndclose();
    }

9.多条件查询

// 获得多条件对象
Example example = new Example(对象.class);
Example.Criteria criteria = example.createCriteria();

// 常见条件方法
andLike()					//模糊查询
andEqualTo()				//等值查询
andLessThanOrEqualTo()		//<=查询
andGreaterThanOrEqualTo()	//>=查询
andBetween()				//区间查询
public void testCondition() {
    UserMapper2 userMapper2 = MyBatisUtils.getMapper(UserMapper2.class);

    Example example = new Example(User.class);
    Example.Criteria criteria = example.createCriteria();
    criteria.andLike("name", "%王%");
    criteria.andEqualTo("sex", "男");

    List<User> list = userMapper2.selectByExample(example);
    for (User user : list) {
        System.out.println(user);
    }

    MyBatisUtils.commitAndclose();
}
<think>我们正在讨论的是MyBatis-Plus与通用Mapper(这里指的是早期流行的tk.mybatis.mapper)的结合使用问题。但请注意,MyBatis-Plus自身已经提供了强大的通用Mapper功能(即BaseMapper),通常不需要再集成tk.mybatis通用Mapper。然而,有些项目可能因为历史原因需要同时使用两者,或者用户误将两者混为一谈。 根据引用[2]和[3],MyBatis-Plus自身已经封装了通用的CRUD方法(通过BaseMapper接口),并且提供了条件构造器(Wrapper)来解决复杂条件查询问题。因此,如果用户已经使用了MyBatis-Plus,那么通常不需要再引入tk.mybatis通用Mapper。 但是,如果用户确实需要将两者结合使用(例如,项目中原先使用了tk.mybatis,后来引入了MyBatis-Plus,需要共存),那么需要注意以下问题: ### 1. 避免同时继承两个Mapper接口 通常情况下,一个Mapper接口不能同时继承两个不同的通用Mapper接口(如`BaseMapper`和`tk.mybatis.mapper.common.Mapper`)。因为Java不支持多继承(接口可以多继承,但两个父接口如果有相同方法签名,会导致冲突)。 **解决方案:** - 如果必须使用两者,可以创建两个不同的Mapper接口,分别继承不同的父接口,然后在Service层分别注入使用。 - 或者,只使用其中一个。MyBatis-Plus的功能已经非常强大,通常可以替代tk.mybatis通用Mapper。 ### 2. 配置冲突 两者都需要在Spring Boot中进行配置,可能会产生冲突。 **MyBatis-Plus配置示例:** ```java @Configuration @MapperScan("com.example.mapper") // 扫描MyBatis-Plus的Mapper接口 public class MybatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); return interceptor; } } ``` **tk.mybatis配置示例(如果同时使用):** ```java @Configuration @MapperScan( basePackages = "com.example.tkmapper", // 注意:这里扫描的包路径要不同于MyBatis-Plus的Mapper路径 markerInterface = Mapper.class, // 指定标记接口 sqlSessionFactoryRef = "sqlSessionFactory" ) public class TkMapperConfig { // 配置tk.mybatis的SqlSessionFactory等 } ``` ### 3. 注解冲突 两者都提供了一些注解(如@Table, @Id等),如果同时使用,要注意避免注解混用。建议统一使用MyBatis-Plus的注解(如`@TableName`, `@TableId`)或tk.mybatis的注解(如`@Table`, `@Id`),不要在一个实体类中混用。 ### 4. 代码生成器冲突 两者都有自己的代码生成器,如果同时使用,需要分别配置生成。 ### 5. 常见问题:Parameter 'xxx' not found 这个问题通常出现在自定义方法中,尤其是在同时使用MyBatis-Plus和tk.mybatis时,可能因为参数传递问题导致。 **解决方法:** - 在自定义方法的参数上使用`@Param`注解明确指定参数名(如之前回答所述)。 - 检查XML中的SQL语句,确保参数引用正确。 ### 6. 推荐方案:仅使用MyBatis-Plus 考虑到MyBatis-Plus已经提供了非常全面的功能(包括通用CRUD、条件构造器、分页、性能分析等),而且与MyBatis原生兼容,建议新项目直接使用MyBatis-Plus,不再引入tk.mybatis。这样也可以避免很多兼容性问题。 **示例:仅使用MyBatis-Plus的Mapper** ```java // UserMapper.java import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.example.entity.User; public interface UserMapper extends BaseMapper<User> { // 这里已经包含了基本的CRUD方法 // 如果需要自定义方法,可以添加 User selectUserById(@Param("id") Long id); } ``` 然后在XML中编写自定义SQL: ```xml <select id="selectUserById" resultType="User"> SELECT * FROM user WHERE id = #{id} </select> ``` ### 总结 1. **避免混合使用**:除非有特殊原因,否则不要同时使用MyBatis-Plus和tk.mybatis通用Mapper。 2. **迁移方案**:如果项目原先使用tk.mybatis,可以逐步迁移到MyBatis-Plus。MyBatis-Plus提供了与tk.mybatis类似的功能,且更加强大。 3. **配置分离**:如果必须共存,务必通过不同的包路径和配置类进行隔离。 4. **参数问题**:在自定义方法中,务必使用`@Param`注解明确参数名称,避免出现参数找不到的问题。 如果用户遇到特定的错误信息(如BindingException),请参考之前的回答进行排查。 §§相关问题§§ 1. MyBatis-Plus 与 tk.mybatis通用 Mapper 主要区别是什么? 2. 如何将项目从 tk.mybatis 迁移到 MyBatis-Plus? 3. MyBatis-Plus 的 BaseMapper 已经提供了哪些方法?</think>### MyBatis-Plus 与通用 Mapper 结合使用指南 根据引用内容,MyBatis-Plus 自身已内置强大的通用 Mapper 功能(通过 `BaseMapper` 接口),无需额外集成第三方通用 Mapper 库(如 tk.mybatis)。以下是正确使用方法和常见问题解决方案: --- #### 一、MyBatis-Plus 通用 Mapper 的正确使用方式 1. **继承 BaseMapper 接口**(引用[3][4]) ```java @Repository public interface UserMapper extends BaseMapper<User> { // 自动获得所有CRUD方法 // 无需手动编写基础SQL } ``` 2. **实体类注解配置**(引用[3]) ```java @TableName("sys_user") // 指定表名 public class User { @TableId(type = IdType.AUTO) // 主键策略 private Long id; @TableField("user_name") // 字段映射 private String username; } ``` 3. **Service 层调用示例** ```java @Service public class UserService { @Autowired private UserMapper userMapper; public User getById(Long id) { return userMapper.selectById(id); // 直接调用内置方法 } } ``` --- #### 二、常见问题解决方案 1. **参数绑定异常**(如 `Parameter 'id' not found`) **原因**:自定义方法中未使用 `@Param` 注解 **解决**: ```java // Mapper接口 User selectCustom(@Param("id") Long id, @Param("ew") Wrapper<User> wrapper); ``` ```xml <!-- XML映射 --> <select id="selectCustom" resultType="User"> SELECT * FROM user WHERE id = #{id} AND ${ew.customSqlSegment} </select> ``` 2. **内置方法被覆盖** **现象**:自定义方法与 MyBatis-Plus 内置方法同名(如 `selectList`) **解决**:重命名自定义方法 ```java // 错误:覆盖内置方法 List<User> selectList(@Param("status") Integer status); // 正确:使用自定义名称 List<User> selectByStatus(@Param("status") Integer status); ``` 3. **Wrapper 条件构造器使用问题**(引用[3]) **正确用法**: ```java QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.eq("status", 1) .like("name", "张"); List<User> users = userMapper.selectList(wrapper); ``` --- #### 三、高级集成方案 若需兼容历史遗留的通用 Mapper(如 tk.mybatis),需配置 Mapper 扫描隔离: ```java @Configuration @MapperScan( basePackages = "com.example.plusmapper", markerInterface = com.baomidou.mybatisplus.core.mapper.BaseMapper.class ) @MapperScan( basePackages = "com.example.tkmapper", markerInterface = tk.mybatis.mapper.common.Mapper.class ) public class MultiMapperConfig { // 隔离不同Mapper实现 } ``` --- #### 四、性能优化建议 1. **启用二级缓存**(引用[1]) ```yaml mybatis-plus: configuration: cache-enabled: true ``` 2. **分页插件配置** ```java @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); return interceptor; } ``` --- #### 总结对比(引用[2]) | **功能** | MyBatis-Generator | 通用 Mapper | MyBatis-Plus | |------------------|-------------------|-------------------|----------------------------| | CRUD 方法生成 | 需手动调用 | 自动生成 | 自动生成 + 条件构造器 | | 条件构造 | 不支持 | 有限支持 | 强大的 Wrapper API | | 注解配置 | 有限 | 完善 | 全面增强 | | 分页插件 | 需手动集成 | 需手动集成 | 内置支持 | > 提示:MyBatis-Plus 已包含通用 Mapper 的核心功能,推荐直接使用其内置的 `BaseMapper` 接口,避免集成复杂度[^2][^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值