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的基礎上封裝出粒度更大、更通用、更好用的方法