當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

Mybatis通用Mapper

發布時間：2025/3/21 编程问答 23 豆豆

生活随笔收集整理的這篇文章主要介紹了 Mybatis通用Mapper 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

極其方便的使用Mybatis單表的增刪改查

項目地址:http://git.oschina.net/free/Mapper

優點?

不客氣的說,使用這個通用Mapper甚至能改變你對Mybatis單表基礎操作不方便的想法,使用它你能簡單的使用單表的增刪改查,包含動態的增刪改查.

程序使用攔截器實現具體的執行Sql,完全使用原生的Mybatis進行操作.

不管你信不信,這個項目的測試代碼中沒有一個Mapper的xml配置文件,但是卻可以做到每個Mapper對應上百行xml才能完成的許多功能.沒有了這些基礎xml信息的干擾,你將會擁有清晰干凈的Mapper.xml.

發現BUG可以提Issue,可以給我發郵件,可以加我QQ,可以進Mybatis群討論.

作者QQ： 120807756

作者郵箱：?abel533@gmail.com

Mybatis工具群： 211286137 (Mybatis相關工具插件等等)

推薦使用Mybatis分頁插件:PageHelper分頁插件

如何使用?

下面是通用Mapper的配置方法,還會提到spring中的配置方法.還有和PageHelper分頁插件集成的配置方式.

1. 引入通用Mapper的代碼

將本項目中的4個代碼文件(EntityHelper,Mapper,MapperHelper,MapperInterceptor)復制到你自己的項目中.

項目依賴于JPA的注解,需要引入persistence-api-1.0.jar或者添加Maven依賴:

<dependency><groupId>javax.persistence</groupId><artifactId>persistence-api</artifactId><version>1.0</version> </dependency>

2. 配置Mapper攔截器

在mybatis-config.xml中添加如下配置:

可配置參數一般情況下不需要修改,直接像下面這樣一行即可:

附:Spring配置相關

如果你使用Spring的方式來配置該攔截器,你可以像下面這樣:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><property name="mapperLocations"><array><value>classpath:mapper/*.xml</value></array></property><property name="typeAliasesPackage" value="com.isea533.mybatis.model"/><property name="plugins"><array><-- 主要看這里 --><bean class="com.isea533.mybatis.mapperhelper.MapperInterceptor"/></array></property> </bean>

只需要像上面這樣配置一個bean即可.

如果你同時使用了PageHelper分頁插件,可以像下面這樣配置:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><property name="mapperLocations"><array><value>classpath:mapper/*.xml</value></array></property><property name="typeAliasesPackage" value="com.isea533.mybatis.model"/><property name="plugins"><array><bean class="com.isea533.mybatis.pagehelper.PageHelper"><property name="properties"><value>dialect=hsqldbreasonable=true</value></property></bean><bean class="com.isea533.mybatis.mapperhelper.MapperInterceptor"/></array></property> </bean>

一定要注意PageHelper和MapperInterceptor這兩者的順序不能顛倒.

如果你想配置MapperInterceptor的參數,可以像PageHelper中的properties參數這樣配置

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

例如下面的例子:

public interface UserInfoMapper extends Mapper<UserInfo> {//其他必須手寫的接口...}

一旦繼承了Mapper<T>,繼承的Mapper就擁有了以下通用的方法:

//根據實體類不為null的字段進行查詢,條件全部使用=號and條件 List<T> select(T record);//根據實體類不為null的字段查詢總數,條件全部使用=號and條件 int selectCount(T record);//根據主鍵進行查詢,必須保證結果唯一 //單個字段做主鍵時,可以直接寫主鍵的值 //聯合主鍵時,key可以是實體類,也可以是Map T selectByPrimaryKey(Object key);//插入一條數據 //支持Oracle序列,UUID,類似Mysql的INDENTITY自動增長(自動回寫) //優先使用傳入的參數值,參數值空時,才會使用序列、UUID,自動增長 int insert(T record);//插入一條數據,只插入不為null的字段,不會影響有默認值的字段 //支持Oracle序列,UUID,類似Mysql的INDENTITY自動增長(自動回寫) //優先使用傳入的參數值,參數值空時,才會使用序列、UUID,自動增長 int insertSelective(T record);//根據實體類中字段不為null的條件進行刪除,條件全部使用=號and條件 int delete(T key);//通過主鍵進行刪除,這里最多只會刪除一條數據 //單個字段做主鍵時,可以直接寫主鍵的值 //聯合主鍵時,key可以是實體類,也可以是Map int deleteByPrimaryKey(Object key);//根據主鍵進行更新,這里最多只會更新一條數據 //參數為實體類 int updateByPrimaryKey(T record);//根據主鍵進行更新 //只會更新不是null的數據 int updateByPrimaryKeySelective(T record);

4. 泛型(實體類)<T>的類型必須符合要求

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

表名默認使用類名,駝峰轉下劃線,如UserInfo默認對應的表名為user_info.

表名可以使用@Table(name = "tableName")進行指定,對不符合第一條默認規則的可以通過這種方式指定表名.

字段默認和@Column一樣,都會作為表字段,表字段默認為Java對象的Field名字駝峰轉下劃線形式.

可以使用@Column(name = "fieldName")指定不符合第3條規則的字段名

使用@Transient注解可以忽略字段,添加該注解的字段不會作為表字段使用.

建議一定是有一個@Id注解作為主鍵的字段,可以有多個@Id注解的字段作為聯合主鍵.

默認情況下,實體類中如果不存在包含@Id注解的字段,所有的字段都會作為主鍵字段進行使用(這種效率極低).

實體類可以繼承使用,可以參考測試代碼中的com.github.abel533.model.UserLogin2類.

由于基本類型,如int作為實體類字段時會有默認值0,而且無法消除,所以實體類中建議不要使用基本類型.

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

這三種方式不能同時使用,同時存在時按照?序列>UUID>主鍵自增的優先級進行選擇.下面是具體配置方法:

使用序列可以添加如下的注解:

//可以用于數字類型,字符串類型(需數據庫支持自動轉型)的字段 @SequenceGenerator(name="Any",sequenceName="seq_userid") @Id private Integer id;

使用UUID時:

//可以用于任意字符串類型長度超過32位的字段 @GeneratedValue(generator = "UUID") private String countryname;

使用主鍵自增:

//不限于@Id注解的字段,但是一個實體類中只能存在一個(繼承關系中也只能存在一個) @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Integer id;

5. 將繼承的Mapper接口添加到Mybatis配置中

例如本項目測試中的配置:

附:Spring配置相關

如果你在Spring中配置Mapper接口,不需要像上面這樣一個個配置,只需要有下面的這個掃描Mapper接口的這個配置即可:

6. 代碼中使用

例如下面這個簡單的例子:

SqlSession sqlSession = MybatisHelper.getSqlSession(); try {//獲取MapperUserInfoMapper mapper = sqlSession.getMapper(UserInfoMapper.class);UserInfo userInfo = new UserInfo();userInfo.setUsername("abel533");userInfo.setPassword("123456");userInfo.setUsertype("2");userInfo.setEmail("abel533@gmail.com");//新增一條數據Assert.assertEquals(1, mapper.insert(userInfo));//ID回寫,不為空Assert.assertNotNull(userInfo.getId());//6是當前的IDAssert.assertEquals(6, (int)userInfo.getId());//通過主鍵刪除新增的數據Assert.assertEquals(1,mapper.deleteByPrimaryKey(userInfo)); } finally {sqlSession.close(); }

另一個例子:

SqlSession sqlSession = MybatisHelper.getSqlSession(); try {//獲取MapperCountryMapper mapper = sqlSession.getMapper(CountryMapper.class);//查詢總數Assert.assertEquals(183, mapper.selectCount(new Country()));//查詢100Country country = mapper.selectByPrimaryKey(100);//根據主鍵刪除Assert.assertEquals(1, mapper.deleteByPrimaryKey(100));//查詢總數Assert.assertEquals(182, mapper.selectCount(new Country()));//插入Assert.assertEquals(1, mapper.insert(country)); } finally {sqlSession.close(); }

附:Spring使用相關

直接在需要的地方注入Mapper繼承的接口即可,和一般情況下的使用沒有區別.

關于和Spring結合的例子,可以看下面的地址:

https://github.com/abel533/Mybatis-Spring

當前版本v0.1.0

這是一個新生的開源項目

首先感謝您能看到這里!

這是一個新生的項目,一切都剛剛開始,雖然項目中包含大量的測試,但是仍然會有很多未知的bug存在,希望各位能夠在使用過程中發現問題時及時反饋,歡迎各位fork本項目進行參與!

from:?http://blog.csdn.net/isea533/article/details/41457529

總結

以上是生活随笔為你收集整理的Mybatis通用Mapper的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇： MyBatis-Spring配置简单了解
下一篇： Git提交到多个远程仓库