SpringBoot集成Mybatis-XML方式通用Mapper

SpringBoot集成通用mapper

pom.xml添加依賴

 <dependency> <groupId>tk.mybatis</groupId> <artifactId>mapper-spring-boot-starter</artifactId> <version>1.1.7</version> </dependency> 

特別注意，如果使用了1.2.0以上版本 @MapperScan 注解，請使用 tk.mybatis.spring.annotation.MapperScan 注解。

application.yml文件配置

mapper: mappers: tk.mybatis.mapper.common.Mapper not-empty: false identity: MYSQL style: camelhump 

可配置參數介紹

 

• UUID：設置生成UUID的方法，需要用OGNL方式配置，不限制返回值，但是必須和字段類型匹配
• IDENTITY：取回主鍵的方式

• DB2: VALUES IDENTITY_VAL_LOCAL()
• MYSQL: SELECT LAST_INSERT_ID()
• SQLSERVER: SELECT SCOPE_IDENTITY()
• CLOUDSCAPE: VALUES IDENTITY_VAL_LOCAL()
• DERBY: VALUES IDENTITY_VAL_LOCAL()
• HSQLDB: CALL IDENTITY()
• SYBASE: SELECT @@IDENTITY
• DB2_MF: SELECT IDENTITY_VAL_LOCAL() FROM >> * SYSIBM.SYSDUMMY1
• INFORMIX: select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
• JDBC:這會令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法來取出由數據庫內部生成的主鍵（比如：像 MySQL 和 SQL Server 這樣的關系數據庫管理系統的自動遞增字段）。

• ORDER：<selectKey>中的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。

使用通用Mapper

繼承通用的Mapper<T>必須指定泛型

例：

 

image.png

泛型實體類必須符合要求

實體類按照如下規則和數據庫表進行轉換,注解全部是JPA中的注解:

• 1.表名默認使用類名,駝峰轉下划線(只對大寫字母進行處理),如TestUser默認對應的表名為test_user
• 2.表名可以使用@Table(name = "tableName")進行指定,對不符合第一條默認規則的可以通過這種方式指定表名.
• 3.字段默認和@Column一樣,都會作為表字段,表字段默認為Java對象的Field名字駝峰轉下划線形式.
• 4.可以使用@Column(name = "fieldName")指定不符合第3條規則的字段名
• 5.使用@Transient注解可以忽略字段,添加該注解的字段不會作為表字段使用.
• 6.建議一定是有一個@Id注解作為主鍵的字段,可以有多個@Id注解的字段作為聯合主鍵.
• 7.默認情況下,實體類中如果不存在包含@Id注解的字段,所有的字段都會作為主鍵字段進行使用(這種效率極低).
• 8.實體類可以繼承使用,可以參考測試代碼中的tk.mybatis.mapper.model.UserLogin2類.
• 9.由於基本類型,如int作為實體類字段時會有默認值0,而且無法消除,所以實體類中建議不要使用基本類型.
• 10.@NameStyle注解，用來配置對象名/字段和表名/字段之間的轉換方式，該注解優先於全局配置style，可選值：
  normal:使用實體類名/屬性名作為表名/字段名
  camelhump:這是默認值，駝峰轉換為下划線形式
  uppercase:轉換為大寫
  lowercase:轉換為小寫

重點強調 @Transient 注解 許多人由於不仔細看文檔，頻繁在這個問題上出錯。如果你的實體類中包含了不是數據庫表中的字段，你需要給這個字段加上@Transient注解，這樣通用Mapper在處理單表操作時就不會將標注的屬性當成表字段處理！

主鍵策略(僅用於insert方法)

通用Mapper還提供了序列(支持Oracle)、UUID(任意數據庫,字段長度32)、主鍵自增(類似Mysql,Hsqldb)三種方式，其中序列和UUID可以配置多個，主鍵自增只能配置一個。

• 1.@GeneratedValue(generator = "JDBC")

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

這會令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法來取出由數據庫內部生成的主鍵（比如：像 MySQL 和 SQL Server 這樣的關系數據庫管理系統的自動遞增字段）

• 2.@GeneratedValue(strategy = GenerationType.IDENTITY)

• 這個注解適用於主鍵自增的情況，支持下面這些數據庫：
  DB2: VALUES IDENTITY_VAL_LOCAL()
  MYSQL: SELECT LAST_INSERT_ID()
  SQLSERVER: SELECT SCOPE_IDENTITY()
  CLOUDSCAPE: VALUES IDENTITY_VAL_LOCAL()
  DERBY: VALUES IDENTITY_VAL_LOCAL()
  HSQLDB: CALL IDENTITY()
  SYBASE: SELECT @@IDENTITY
  DB2_MF: SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
  INFORMIX: select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
  使用GenerationType.IDENTITY需要在全局配置中配置IDENTITY的參數值，並且需要根據數庫配置ORDER屬性。

• 3.@GeneratedValue(generator = "UUID")

可以用於任意字符串類型長度超過32位的字段

@Id @GeneratedValue(generator = "UUID") private Integer id; 

接口及使用大全

基礎接口

Insert

1.InsertMapper<T>

接口：InsertMapper<T>
方法：int insert(T record);
說明：保存一個實體，null的屬性也會保存，不會使用數據庫默認值

   public int insertTestUser(TestUser testUser) { return testUserMapper.insert(testUser); } 

結果：

 

插入結果.png

2.InsertSelectiveMapper<T>

接口：InsertSelectiveMapper<T>
方法：int insertSelective(T record);
說明：保存一個實體，null的屬性不會保存，會使用數據庫默認值
結果：
請自行實驗

Update

1.UpdateByPrimaryKeyMapper<T>

接口：UpdateByPrimaryKeyMapper<T>
方法：int updateByPrimaryKey(T record);
說明：根據主鍵更新實體全部字段，null值會被更新

結果：
會把沒有值的屬性變成空請自行實驗

2.UpdateByPrimaryKeySelectiveMapper<T>

接口：UpdateByPrimaryKeySelectiveMapper<T>
方法：int updateByPrimaryKeySelective(T record);
說明：根據主鍵更新屬性不為null的值

    public int updateTestUser() { TestUser testUser=new TestUser(); testUser.setId("5f7139ef295d42a3b964c082e0dd838f"); testUser.setName("李四四"); return testUserMapper.updateByPrimaryKeySelective(testUser); } 

結果:

 

更新.png

Delete

1.DeleteMapper<T>

接口：DeleteMapper<T>
方法：int delete(T record);
說明：根據實體屬性作為條件進行刪除，查詢條件使用等號

    public int deleteTestUser() { TestUser testUser=new TestUser(); //根據屬性刪除會把所有密碼是123456的數據刪除 testUser.setPassword("123456"); return testUserMapper.delete(testUser); } 

結果：
四個已經全部刪除

 

刪除.png

2.DeleteByPrimaryKeyMapper<T>

接口：DeleteByPrimaryKeyMapper<T>
方法：int deleteByPrimaryKey(Object key);
說明：根據主鍵字段進行刪除，方法參數必須包含完整的主鍵屬性

   public int deleteKeyTestUser() { //根據主鍵ID刪除 return testUserMapper.deleteByPrimaryKey("5f7139ef295d42a3b964c082e0dd838f"); } 

結果：

 

刪除.png

Select

1.SelectMapper<T>

接口：SelectMapper<T>
方法：List<T> select(T record);
說明：根據實體中的屬性值進行查詢，查詢條件使用等號

    public List<TestUser> selectTestUser() { TestUser testUser=new TestUser(); testUser.setPassword("123456"); testUser.setUsername("lisi"); return testUserMapper.select(testUser); } 

結果：

 

查找.png

2.SelectByPrimaryKeyMapper<T>

接口：SelectByPrimaryKeyMapper<T>
方法：T selectByPrimaryKey(Object key);
說明：根據主鍵字段進行查詢，方法參數必須包含完整的主鍵屬性，查詢條件使用等號

結果:
根據主鍵查詢請自行實驗

3.SelectAllMapper<T>

接口：SelectAllMapper<T>
方法：List<T> selectAll();
說明：查詢全部結果，select(null)方法能達到同樣的效果

結果:
查詢所有請自行實驗

4.SelectOneMapper<T>

接口：SelectOneMapper<T>
方法：T selectOne(T record);
說明：根據實體中的屬性進行查詢，只能有一個返回值，有多個結果是拋出異常，查詢條件使用等號

    public TestUser selectOneTestUser() { TestUser testUser=new TestUser(); testUser.setUsername("wangwu"); //結果只能返回一條數據否則會拋出異常 return testUserMapper.selectOne(testUser); } 

結果:

 

查詢一條數據.png

5.SelectCountMapper<T>

接口：SelectCountMapper<T>
方法：int selectCount(T record);
說明：根據實體中的屬性查詢總數，查詢條件使用等號

結果:
返回查詢個數請自行實驗

Example 方法

Select 方法

1.SelectByExampleMapper<T>

接口：SelectByExampleMapper<T>
方法：List<T> selectByExample(Object example);
說明：根據Example條件進行查詢
重點：這個查詢支持通過Example類指定查詢列，通過selectProperties方法指定查詢列

    public List<TestUser> selectExample() { Example example = new Example(TestUser.class); //排序方法setOrderByClause("字段名 ASC")DESC降序 example.setOrderByClause("name ASC"); example.createCriteria() //添加xxx字段等於value條件 .andEqualTo("password","123456") //模糊查詢xxx字段like value條件 .andLike("name","%四%") //可以自由拼接SQL //.andCondition("ID = '5f7139ef295d42a3b964c082e0dd838f' ") //或者可以這么寫 .andCondition("ID =","5f7139ef295d42a3b964c082e0dd838f") ; return testUserMapper.selectByExample(example); } 

實例解析:

mybatis的逆向工程中會生成實例及實例對應的example，example用於添加條件，相當where后面的部分
Example example = new Example();
Criteria criteria = example.createCriteria();

方法	說明
example.setOrderByClause(“字段名 ASC”)	添加升序排列條件，DESC為降序
example.setDistinct(false)	去除重復，boolean型，true為選擇不重復的記錄。
criteria.andIsNull("字段")	添加字段xxx為null的條件
criteria.andIsNotNull("字段")	添加字段xxx不為null的條件
criteria.andEqualTo("字段",value)	添加xxx字段等於value條件
criteria.andNotEqualTo("字段",value)	添加xxx字段不等於value條件
criteria.andGreaterThan("字段",value)	添加xxx字段大於value條件
criteria.andGreaterThanOrEqualTo("字段",value)	添加xxx字段大於等於value條件
criteria.andLessThan("字段",value)	添加xxx字段小於value條件
criteria.andLessThanOrEqualTo("字段",value)	添加xxx字段小於等於value條件
criteria.andIn("字段",List<?>)	添加xxx字段值在List<?>條件
criteria.andNotIn("字段",List<?>)	添加xxx字段值不在List<?>條件
criteria.andLike("字段",“%”+value+”%”)	添加xxx字段值為value的模糊查詢條件
criteria.andNotLike("字段",“%”+value+”%”)	添加xxx字段值不為value的模糊查詢條件
criteria.andBetween(value1,value2)	添加xxx字段值在value1和value2之間條件
criteria.andNotBetween(value1,value2)	添加xxx字段值不在value1和value2之間條件
criteria.andCondition("SQL")	可以寫字符串拼接SQL
criteria.andCondition("字段 =",value)	前面可以寫SQL后面可以寫值

還有criteria.orxxxx的方法跟上面一樣這里不做解釋

2. SelectCountByExampleMapper<T>

接口：SelectCountByExampleMapper<T>
方法：int selectCountByExample(Object example);
說明：根據Example條件進行查詢總數

查詢總數的方法跟上面的寫法一樣

Update 方法

UpdateByExampleMapper<T>

接口：UpdateByExampleMapper<T>
方法：int updateByExample(@Param("record") T record, @Param("example") Object example);
說明：根據Example條件更新實體record包含的全部屬性，null值會被更新

UpdateByExampleSelectiveMapper<T>

接口：UpdateByExampleSelectiveMapper<T>
方法：int updateByExampleSelective(@Param("record") T record, @Param("example") Object example);
說明：根據Example條件更新實體record包含的不是null的屬性值

Delete 方法

DeleteByExampleMapper<T>

接口：DeleteByExampleMapper<T>
方法：int deleteByExample(Object example);
說明：根據Example條件刪除數據

作者：郭少華
鏈接：https://www.jianshu.com/p/336c71c68a52
來源：簡書
簡書著作權歸作者所有，任何形式的轉載都請聯系作者獲得授權並注明出處。