mybaties中通用mapper的基本使用

使用Mybatis的开发者，大多数都会遇到一个问题，就是要写大量的SQL在xml文件中，除了特殊的业务逻辑SQL以外，还有大量结构相似的增删改查SQL。并且，当数据库表结构改动时，对应的全部SQL以及实体类都须要更改。这工做量和效率的影响或许就是区别增删改查程序员和真正程序员的屏障。这时，通用Mapper便应运而生……

什么是通用Mapper？
通用Mapper就是为了解决单表增删改查，基于Mybatis的插件。开发人员不须要编写SQL，不须要在DAO中增长方法，只要写好实体类，就能支持相应的增删改查方法。 

 

Maven依赖
 

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

 

SpringMVC配置

<!-- 通用 Mapper -->
<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.dao"/>
    <property name="properties">
        <value>
            mappers=tk.mybatis.mapper.common.Mapper
        </value>
    </property>
</bean>

 

注意这里使用tk.mybatis.spring.mapper.MapperScannerConfigure替换原来Mybatis的org.mybatis.spring.mapper.MapperScannerConfigurer
可配参数介绍：
UUID：设置生成UUID的方法，须要用OGNL方式配置，不限制返回值，可是必须和字段类型匹配
IDENTITY：取回主键的方式，能够配置的内容看下一篇如何使用中的介绍
ORDER：<seletKey>中的order属性，可选值为BEFORE和AFTER
catalog：数据库的catalog，若是设置该值，查询的时候表名会带catalog设置的前缀
schema：同catalog，catalog优先级高于schema
seqFormat：序列的获取规则,使用{num}格式化参数，默认值为{0}.nextval，针对Oracle，可选参数一共4个，对应0,1,2,3分别为SequenceName，ColumnName, PropertyName，TableName
notEmpty：insert和update中，是否判断字符串类型!=’’，少数方法会用到
style：实体和表转换时的规则，默认驼峰转下划线，可选值为normal用实体名和字段名;camelhump是默认值，驼峰转下划线;uppercase转换为大写;lowercase转换为小写
enableMethodAnnotation：能够控制是否支持方法上的JPA注解，默认false。
大多数状况下不会用到这些参数，有特殊状况能够自行研究

 

实体类的写法
记住一个原则：实体类的字段数量 >= 数据库表中须要操做的字段数量。默认状况下，实体类中的全部字段都会做为表中的字段来操做，若是有额外的字段，必须加上@Transient注解

@Table(name = "test_table")
public class TestTableVO implements Serializable {

    private static final long serialVersionUID = 1L;

    @Id
    @GeneratedValue(generator = "JDBC")
    private Long id;

    @Transient
    private String userId;

    private String name;

    private Timestamp createTime;

    private String createUserId;

    private Timestamp updateTime;

    private String updateUserId;

    private Integer isDelete;
    
    // 省略get、set...
    
}

1.表名默认使用类名,驼峰转下划线(只对大写字母进行处理),如UserInfo默认对应的表名为user_info。
2.表名可使用@Table(name = "tableName")进行指定,对不符合第一条默认规则的能够经过这种方式指定表名.
3.字段默认和@Column同样,都会做为表字段,表字段默认为Java对象的Field名字驼峰转下划线形式.
4.可使用@Column(name = "fieldName")指定不符合第3条规则的字段名
5.使用@Transient注解能够忽略字段,添加该注解的字段不会做为表字段使用.
6.建议必定是有一个@Id注解做为主键的字段,能够有多个@Id注解的字段做为联合主键.
7.若是是MySQL的自增字段，加上@GeneratedValue(generator = "JDBC")便可

 

DAO的写法
在传统的Mybatis写法中，DAO接口须要与Mapper文件关联，即须要编写SQL来实现DAO接口中的方法。而在通用Mapper中，DAO只须要继承一个通用接口，便可拥有丰富的方法
public interface UserMapper2 extends Mapper<User>{....}
一旦继承了Mapper，继承的Mapper就拥有了Mapper全部的通用方法

Select
方法：List<T> select(T record);
说明：根据实体中的属性值进行查询，查询条件使用等号

方法：T selectByPrimaryKey(Object key);
说明：根据主键字段进行查询，方法参数必须包含完整的主键属性，查询条件使用等号

方法：List<T> selectAll();
说明：查询所有结果，select(null)方法能达到一样的效果

方法：T selectOne(T record);
说明：根据实体中的属性进行查询，只能有一个返回值，有多个结果是抛出异常，查询条件使用等号

方法：int selectCount(T record);
说明：根据实体中的属性查询总数，查询条件使用等号

Insert
方法：int insert(T record);
说明：保存一个实体，null的属性也会保存，不会使用数据库默认值

方法：int insertSelective(T record);
说明：保存一个实体，null的属性不会保存，会使用数据库默认值

Update
方法：int updateByPrimaryKey(T record);
说明：根据主键更新实体所有字段，null值会被更新

方法：int updateByPrimaryKeySelective(T record);
说明：根据主键更新属性不为null的值

Delete
方法：int delete(T record);
说明：根据实体属性做为条件进行删除，查询条件使用等号

方法：int deleteByPrimaryKey(Object key);
说明：根据主键字段进行删除，方法参数必须包含完整的主键属性

Example方法
方法：List<T> selectByExample(Object example);
说明：根据Example条件进行查询
重点：这个查询支持经过Example类指定查询列，经过selectProperties方法指定查询列

方法：int selectCountByExample(Object example);
说明：根据Example条件进行查询总数

方法：int updateByExample(@Param("record") T record, @Param("example") Object example);
说明：根据Example条件更新实体record包含的所有属性，null值会被更新

方法：int updateByExampleSelective(@Param("record") T record, @Param("example") Object example);
说明：根据Example条件更新实体record包含的不是null的属性值

方法：int deleteByExample(Object example);
说明：根据Example条件删除数据

 

测试代码：
public List<User> test1(){
   List<User> userList= userMapper.selectAll();
   return userList;
}

public List<User> test2(){
	User user=new User();
	user.setUserName("李医生");
	List<User> userList= userMapper.select(user);
	return userList;
}

public List<User> test3(){
	Example example=new Example(User.class);
	Example.Criteria criteria= example.createCriteria();
	criteria.andEqualTo("userRole","2");
	criteria.andLike("userName","%医生%");
	List<User> userList=userMapper.selectByExample(example);
	return userList;
}

注意：若是springboot开启了热部署(spring-boot-devtools)，那么在使用的过程当中可能会出现实体类类型转换异常，好比 User user=userDao.selectOne(X);  ，看起来没有任何问题，排查也没有任何问题，因此须要特别注意

总结：
通用Mapper的原理是经过反射获取实体类的信息，构造出相应的SQL，所以咱们只须要维护好实体类便可，对于应付复杂多变的需求提供了很大的便利。上文叙述的只是通用Mapper的简单用法，在实际项目中，仍是要根据业务，在通用Mapper的基础上封装出粒度更大、更通用、更好用的方法