辅助mybatis简单表开发的组件 —— 通用Mapper

什么是通用Mapper

通用mapper 可以极大的方便开发人员进行ORM，提供极其方便的单表增删改查。

什么是通用mapper，一句话简单说，它就是个辅助mybatis极简单表开发的组件。它不是为了替代mybatis，而是让mybatis的开发更方便。

可以按照自己的需要选择通用方法，还能很方便的开发自己的通用方法。

官方文档：https://mapperhelper.github.io/docs/

为什么要用通用mapper？

原生Mybatis的痛点

1）mapper.xml文件里有大量的sql，当数据库表字段变动，配置文件就要修改

2）需要自己实现sql分页，select * from table where . . . limit 1,3

自己手写分页，除了传参page、pageSize，还需要返回条目总数count。

3）数据库可移植性差：如果项目更换数据库，比如oracle-->mysql，mapper.xml中的sql要重新写，因为Oracle的PLSQL 和mysql 支持的函数是不同的。

4）生成的代码量过大。

5）批量操作，批量插入，批量更新，需要自写。

使用通用Mapper注意项

通用Mapper极其方便的使用MyBatis单表的增删改查。不支持通用的多表联合查询。
通用Mapper3支持 Mybatis-3.2.4 及以上版本
不是表中字段的属性必须加 @Transient 注解
Mapper3在查询的时候支持通过 @OrderBy 注解来设置默认的排序方式。

快速整合通用Mapper

mybatis与spring整合，在此基础上，接下来我们看看怎么快速通用mapper。

① 添加通用Mapper依赖

<!--通用Mapper-->
<dependency>
	<groupId>tk.mybatis</groupId>
	<artifactId>mapper</artifactId>
	<version>3.5.3</version>
</dependency>

② 纯 Spring 配置方式

<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.harvey.mapper"/>
    <property name="properties">
        <value>
            mappers=tk.mybatis.mapper.common.Mapper
        </value>
    </property>
</bean>

注意：这里是 tk.mybatis.xxx,和MyBatis的唯一区别就是 org. 改成了 tk.，方便修改和记忆。

通用Mapper的各项属性通过 properties 属性进行配置，如果默认配置就是一行mappers=tk.mybatis.mapper.common.Mapper时，可以不写，就会变成：

<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.harvey.mapper"/>
</bean>

③ mapper接口开发：继承通用的Mapper<T>,必须指定泛型<T>

public interface UserInfoMapper extends Mapper<UserInfo> {
  //其他必须手写的接口...

}

一旦继承了Mapper<T>,继承的Mapper就拥有了Mapper<T>所有的通用方法。

UserInfo.java

@Table(name = "user")
public class UserInfo {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    private Integer id;

    @Column(name = "username")
    private String username;

    @Column(name = "sex")
    private String sex;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    @Override
    public String toString() {

        return "User [id=" + id + ", username=" + username + ", sex=" + sex
                + "]";
    }
}

实体类按照如下规则和数据库表进行转换，注解全部是JPA中的注解：

表名默认使用类名，驼峰转下划线(只对大写字母进行处理)，如UserInfo默认对应的表名为user_info。
表名可以使用@Table(name = "tableName")进行指定，对不符合第一条默认规则的可以通过这种方式指定表名。
字段默认和@Column一样，都会作为表字段，表字段默认为Java对象的Field名字驼峰转下划线形式。
可以使用@Column(name = "fieldName")指定不符合第3条规则的字段名。
使用@Transient注解可以忽略字段,添加该注解的字段不会作为表字段使用（即非表字段一定要添加@Transient注解）。
建议一定是有一个@Id注解作为主键的字段,可以有多个@Id注解的字段作为联合主键。
默认情况下,实体类中如果不存在包含@Id注解的字段，所有的字段都会作为主键字段进行使用(这种效率极低)。
实体类可以继承使用
由于基本类型,如int作为实体类字段时会有默认值0,而且无法消除,所以实体类中建议不要使用基本类型。
@NameStyle注解，用来配置对象名/字段和表名/字段之间的转换方式，该注解优先于全局配置style，可选值：
- normal：使用实体类名/属性名作为表名/字段名
- camelhump：这是默认值，驼峰转换为下划线形式
- uppercase：转换为大写
- lowercase：转换为小写

主键策略有以下多种：

@GeneratedValue(generator = "JDBC")
@GeneratedValue(strategy = GenerationType.IDENTITY)
@GeneratedValue(generator = "UUID")
......

④ 将继承的Mapper接口添加到Mybatis配置中

如果你在Spring中配置Mapper接口,则需要有下面的这个扫描Mapper接口的这个配置：

<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
  <property name="basePackage" value="com.harvey.mapper"/>
</bean>

另外因为通用接口都有顶层的接口，所以你还可以用下面的方式进行配置：

<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
  <property name="basePackage" value="com.**.mapper"/>
  <property name="markerInterface" value="tk.mybatis.mapper.common.Mapper"/>
</bean>

这样配置后，直接继承了Mapper接口的才会被扫描，basePackage可以配置的范围更大。

注意，如果有一些方法我们需要写在xml中，则同样要遵循以下规范：

XxxMapper 接口必须要和 XxxMapper.xml 文件同名且在同一个包下，也就是说 XxxMapper.xml 文件中的namespace是XxxMapper接口的全类名

XxxMapper接口中的方法名和 XxxMapper.xml 文件中定义的 id 一致

XxxMapper接口输入参数类型要和 XxxMapper.xml 中定义的 parameterType 一致

XxxMapper接口返回数据类型要和 XxxMapper.xml 中定义的 resultType 一致

当然，如果我们在创建org.mybatis.spring.SqlSessionFactoryBean时指定了mapperLocations属性就可以摆脱第一点的束缚。如下：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    
    <property name="configLocation" value="classpath:mybatis-configuration.xml"/>
    
    <property name="dataSource" ref="dataSource"/>
    
    
</bean>

⑤ 测试代码

@RunWith(SpringJUnit4ClassRunner.class)//表示整合JUnit4进行测试
@ContextConfiguration(locations={"classpath:applicationContext.xml"})//加载spring配置文件
public class BaseJunit4Test {

    @Autowired
    private UserInfoMapper userInfoMapper;

    @Test
    public void testSelectUserById() throws Exception {
        UserInfo user = userInfoMapper.selectByPrimaryKey(1);
        System.out.println(user);

    }
}