springBoot使用通用mapper记录

通用mapper简述

• 在日常开发中，新建实体后需要写很多简单重复的单表sql，在后期实体类中增删字段时，还需要同步维护sql语句，造成诸多不便，通用Mapper就是为了解决单表增删改查，基于Mybatis的插件。开发人员不需要编写SQL，不需要在DAO中增加方法，只要写好实体类，就能支持相应的增删改查方法。

根据作者的文档文档，通用mapper与springboot集成分为两类，经过测试总结如下：

1. 基于 starter 的自动配置
2. 基于 @MapperScan 注解的手工配置

作者原文：https://github.com/abel533/Mapper/wiki/1.3-spring-boot
可以阅读原文理解的透彻一些，接下来贴我的实际配置

1 基于 starter 的自动配置的实际使用

1. maven依赖的jar

<!--通用Mapper插件-->
		<dependency>
			<groupId>tk.mybatis</groupId>
			<artifactId>mapper-spring-boot-starter</artifactId>
			<version>2.1.5</version>
		</dependency>

2. 配置一个通用mapper类，不要放在Dao同一层，该接口不能被扫描到，否则会出错

/**
 * @Author: shuyh
 * @Date: 2020/12/29 11:57
 */
public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T>, ConditionMapper<T>, IdsMapper<T> {
    //TODO
    //FIXME 特别注意，该接口不能被扫描到，否则会出错
}

3. 在配置文件中，设置如下，加入你的通用mapper路径（下文用MyMapper描述），yml格式自行转化

# 通用mapper 实体类不能有基本数据类型，不然通过字段不能查询
mapper.mappers=com.syh.demo.util.MyMapper
mapper.not-empty=true
mapper.identity=MYSQL

4. 实体类需要与表映射

/**
 * @Author: shuyh
 * @Date: 2020/12/29 11:45
 */
@Table(name = "user")//mybatis通用接口mapper依赖JPA实体类采用JPA
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)//通过id自增
    private Integer uid;

    @Column(name = "username")//字段与数据库不一致，注释使用别名
    private String username;

    private String password;
    @Transient//不与表映射
    private String role;

这里有一个坑，@id注解，需要装箱类，例如int，需要使用Integer，long需要使用Long，不然会遇到报错：Caused by: tk.mybatis.mapper.MapperException: 继承 selectByIds 方法的实体类[com.syh.demo.model.User]中必须只有一个带有 @Id 注解的字段

5. 在你的Dao层，继承myMapper，而且需要使用注解@Mapper，不可使用@Component，不然也会报错

/**
 * @Author: shuyh
 * @Date: 2020/12/29 13:15
 */
@Mapper
public interface UserDao extends MyMapper<User> {

}

6. 调用单表的增删改查

public void getAllUser() {
        List<User> user= userDao.selectAll();
        for (User user1:user
             ) {
            System.out.println(user1.getUsername());
        }
    }

2.基于 @MapperScan 注解的手工配置

这个相对来说简单一些

1. maven依赖的jar

<!--通用Mapper插件-->
		<dependency>
			<groupId>tk.mybatis</groupId>
			<artifactId>mapper-spring-boot-starter</artifactId>
			<version>2.1.5</version>
		</dependency>

2. 配置myMapper类和entity实体类，Dao层继承myMapper接口，步骤同上，不再赘述
3. 你可以给带有 @Configuration 的类配置该注解，或者直接配置到 Spring Boot 的启动类上，如下：

@SpringBootApplication
@MapperScan(basePackages = {"com.syh.demo.dao"})
public class SpringbootApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringbootApplication.class, args);
	}

}

注意：这里使用的 tk.mybatis.spring.annotation.MapperScan !，不然也会报错
4. 直接调用myMapper方法
收工