使用Mybatis的開(kāi)發(fā)者，大多數(shù)都會(huì)遇到一個(gè)問(wèn)題，就是要寫(xiě)大量的SQL在xml文件中，除了特殊的業(yè)務(wù)邏輯SQL之外，還有大量結(jié)構(gòu)類似的增刪改查SQL。而且，當(dāng)數(shù)據(jù)庫(kù)表結(jié)構(gòu)改動(dòng)時(shí)，對(duì)應(yīng)的所有SQL以及實(shí)體類都需要更改。這工作量和效率的影響或許就是區(qū)別增刪改查程序員和真正程序員的屏障。這時(shí)，通用Mapper便應(yīng)運(yùn)而生……

什么是通用Mapper

通用Mapper就是為了解決單表增刪改查，基于Mybatis的插件。開(kāi)發(fā)人員不需要編寫(xiě)SQL，不需要在DAO中增加方法，只要寫(xiě)好實(shí)體類，就能支持相應(yīng)的增刪改查方法。

如何使用

以MySQL為例，假設(shè)存在這樣一張表：

CREATE TABLE `test_table` (
 `id` bigint(20) NOT NULL AUTO_INCREMENT,
 `name` varchar(255) DEFAULT '',
 `create_time` datetime DEFAULT NULL,
 `create_user_id` varchar(32) DEFAULT NULL,
 `update_time` datetime DEFAULT NULL,
 `update_user_id` varchar(32) DEFAULT NULL,
 `is_delete` int(8) DEFAULT NULL,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

主鍵是 id ，自增。下面以這張表為例介紹如何使用通用Mapper。

Maven依賴

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

SpringMVC配置

<!-- 通用 Mapper -->
<beanclass="tk.mybatis.spring.mapper.MapperScannerConfigurer">
  <propertyname="basePackage"value="cn.com.bluemoon.bd.service.spider.dao"/>
  <propertyname="properties">
    <value>
      mappers=tk.mybatis.mapper.common.Mapper
    </value>
  </property>
</bean>

注意這里使用 tk.mybatis.spring.mapper.MapperScannerConfigure 替換原來(lái)Mybatis的 org.mybatis.spring.mapper.MapperScannerConfigurer 。

可配參數(shù)介紹：

1. UUID ：設(shè)置生成UUID的方法，需要用OGNL方式配置，不限制返回值，但是必須和字段類型匹配
2. IDENTITY ：取回主鍵的方式，可以配置的內(nèi)容看下一篇如何使用中的介紹
3. ORDER ： <seletKey> 中的order屬性，可選值為BEFORE和AFTER
4. catalog ：數(shù)據(jù)庫(kù)的catalog，如果設(shè)置該值，查詢的時(shí)候表名會(huì)帶catalog設(shè)置的前綴
5. schema ：同catalog，catalog優(yōu)先級(jí)高于schema
6. seqFormat ：序列的獲取規(guī)則,使用{num}格式化參數(shù)，默認(rèn)值為{0}.nextval，針對(duì)Oracle，可選參數(shù)一共4個(gè)，對(duì)應(yīng)0,1,2,3分別為SequenceName，ColumnName, PropertyName，TableName
7. notEmpty ：insert和update中，是否判斷字符串類型!=''，少數(shù)方法會(huì)用到
8. style ：實(shí)體和表轉(zhuǎn)換時(shí)的規(guī)則，默認(rèn)駝峰轉(zhuǎn)下劃線，可選值為normal用實(shí)體名和字段名;camelhump是默認(rèn)值，駝峰轉(zhuǎn)下劃線;uppercase轉(zhuǎn)換為大寫(xiě);lowercase轉(zhuǎn)換為小寫(xiě)
9. enableMethodAnnotation ：可以控制是否支持方法上的JPA注解，默認(rèn)false。

大多數(shù)情況下不會(huì)用到這些參數(shù)，有特殊情況可以自行研究。

實(shí)體類的寫(xiě)法

記住一個(gè)原則：實(shí)體類的字段數(shù)量 >= 數(shù)據(jù)庫(kù)表中需要操作的字段數(shù)量。默認(rèn)情況下，實(shí)體類中的所有字段都會(huì)作為表中的字段來(lái)操作，如果有額外的字段，必須加上 @Transient 注解。

@Table(name = "test_table")
public class TestTableVOimplements 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...  
}

說(shuō)明：

1. 表名默認(rèn)使用類名,駝峰轉(zhuǎn)下劃線(只對(duì)大寫(xiě)字母進(jìn)行處理),如 UserInfo 默認(rèn)對(duì)應(yīng)的表名為 user_info 。
2. 表名可以使用 @Table(name = "tableName") 進(jìn)行指定,對(duì)不符合第一條默認(rèn)規(guī)則的可以通過(guò)這種方式指定表名.
3. 字段默認(rèn)和 @Column 一樣,都會(huì)作為表字段,表字段默認(rèn)為Java對(duì)象的Field名字駝峰轉(zhuǎn)下劃線形式.
4. 可以使用 @Column(name = "fieldName") 指定不符合第3條規(guī)則的字段名
5. 使用 @Transient 注解可以忽略字段,添加該注解的字段不會(huì)作為表字段使用.
6. 建議一定是有一個(gè) @Id 注解作為主鍵的字段,可以有多個(gè) @Id 注解的字段作為聯(lián)合主鍵.
7. 如果是MySQL的自增字段，加上 @GeneratedValue(generator = "JDBC") 即可。

DAO 的寫(xiě)法

在傳統(tǒng)的Mybatis寫(xiě)法中， DAO 接口需要與 Mapper 文件關(guān)聯(lián)，即需要編寫(xiě) SQL 來(lái)實(shí)現(xiàn) DAO 接口中的方法。而在通用Mapper中， DAO 只需要繼承一個(gè)通用接口，即可擁有豐富的方法：

繼承通用的Mapper ，必須指定泛型

public interface TestTableDaoextends Mapper<TestTableVO>{
}

一旦繼承了Mapper ，繼承的Mapper就擁有了Mapper 所有的通用方法：

Select

方法： List<T> select(T record);
說(shuō)明：根據(jù)實(shí)體中的屬性值進(jìn)行查詢，查詢條件使用等號(hào)

方法： T selectByPrimaryKey(Object key);
說(shuō)明：根據(jù)主鍵字段進(jìn)行查詢，方法參數(shù)必須包含完整的主鍵屬性，查詢條件使用等號(hào)

方法： List<T> selectAll();
說(shuō)明：查詢?nèi)拷Y(jié)果，select(null)方法能達(dá)到同樣的效果

方法： T selectOne(T record);
說(shuō)明：根據(jù)實(shí)體中的屬性進(jìn)行查詢，只能有一個(gè)返回值，有多個(gè)結(jié)果是拋出異常，查詢條件使用等號(hào)

方法： int selectCount(T record);
說(shuō)明：根據(jù)實(shí)體中的屬性查詢總數(shù)，查詢條件使用等號(hào)

Insert

方法： int insert(T record);
說(shuō)明：保存一個(gè)實(shí)體，null的屬性也會(huì)保存，不會(huì)使用數(shù)據(jù)庫(kù)默認(rèn)值

方法： int insertSelective(T record);
說(shuō)明：保存一個(gè)實(shí)體，null的屬性不會(huì)保存，會(huì)使用數(shù)據(jù)庫(kù)默認(rèn)值

Update

方法： int updateByPrimaryKey(T record);
說(shuō)明：根據(jù)主鍵更新實(shí)體全部字段，null值會(huì)被更新

方法： int updateByPrimaryKeySelective(T record);
說(shuō)明：根據(jù)主鍵更新屬性不為null的值

Delete

方法： int delete(T record);
說(shuō)明：根據(jù)實(shí)體屬性作為條件進(jìn)行刪除，查詢條件使用等號(hào)

方法： int deleteByPrimaryKey(Object key);
說(shuō)明：根據(jù)主鍵字段進(jìn)行刪除，方法參數(shù)必須包含完整的主鍵屬性

Example方法

方法： List<T> selectByExample(Object example);
說(shuō)明：根據(jù)Example條件進(jìn)行查詢

重點(diǎn)：這個(gè)查詢支持通過(guò) Example 類指定查詢列，通過(guò) selectProperties 方法指定查詢列

方法： int selectCountByExample(Object example);
說(shuō)明：根據(jù)Example條件進(jìn)行查詢總數(shù)

方法： int updateByExample(@Param("record") T record, @Param("example") Object example);
說(shuō)明：根據(jù)Example條件更新實(shí)體 record 包含的全部屬性，null值會(huì)被更新

方法： int updateByExampleSelective(@Param("record") T record, @Param("example") Object example);
說(shuō)明：根據(jù)Example條件更新實(shí)體 record 包含的不是null的屬性值

方法： int deleteByExample(Object example);
說(shuō)明：根據(jù)Example條件刪除數(shù)據(jù)

代碼中使用

在 service 中注入 dao ，即可使用。

@Autowired
private TestTableDao testTableDao;

下面演示大概的寫(xiě)法：

新增

TestTableVO vo = new TestTableVO();
// 省略為vo設(shè)置屬性...
int row = testTableDao.insertSelective(vo);

修改

TestTableVO vo = new TestTableVO();
// 省略為vo設(shè)置屬性...
int row = testTableDao.updateByPrimaryKeySelective(vo);

查詢單個(gè)

TestTableVO vo = new TestTableVO();
vo.setId(123L);
TestTableVO result = testTableDao.selectOne(vo);

條件查詢

// 創(chuàng)建Example
Example example = new Example(TestTableVO.class);
// 創(chuàng)建Criteria
Example.Criteria criteria = example.createCriteria();
// 添加條件
criteria.andEqualTo("isDelete", 0);
criteria.andLike("name", "%abc123%");
List<TestTableVO> list = testTableDao.selectByExample(example);

總結(jié)

通用Mapper的原理是通過(guò)反射獲取實(shí)體類的信息，構(gòu)造出相應(yīng)的SQL，因此我們只需要維護(hù)好實(shí)體類即可，對(duì)于應(yīng)付復(fù)雜多變的需求提供了很大的便利。上文敘述的只是通用Mapper的簡(jiǎn)單用法，在實(shí)際項(xiàng)目中，還是要根據(jù)業(yè)務(wù)，在通用Mapper的基礎(chǔ)上封裝出粒度更大、更通用、更好用的方法。

附 Spring Boot 配置

Maven

<!--mybatis-->
<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>1.3.1</version>
</dependency>
<!--mapper-->
<dependency>
  <groupId>tk.mybatis</groupId>
  <artifactId>mapper-spring-boot-starter</artifactId>
  <version>1.1.4</version>
</dependency>

application.properties 配置

#mapper
#mappers 多個(gè)接口時(shí)逗號(hào)隔開(kāi)
mapper.mappers=tk.mybatis.mapper.common.Mapper
mapper.not-empty=false
mapper.identity=MYSQL

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論