Mybatis通用Mapper

時間 2019-11-18

原文原文鏈接

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

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

優勢?

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

程序使用攔截器實現具體的執行Sql,徹底使用原生的Mybatis進行操做. git

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

發現BUG能夠提Issue,能夠給我發郵件,能夠加我QQ,能夠進Mybatis羣討論. sql

做者QQ： 120807756 數據庫

做者郵箱： abel533@gmail.com api

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

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

如何使用?

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

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中添加以下配置:

<plugins> <plugin interceptor="com.github.abel533.mapper.MapperInterceptor"> <!--================================================--> <!--可配置參數說明(通常無需修改)--> <!--================================================--> <!--UUID生成策略--> <!--配置UUID生成策略須要使用OGNL表達式--> <!--默認值32位長度:@java.util.UUID@randomUUID().toString().replace("-", "")--> <!--<property name="UUID" value="@java.util.UUID@randomUUID().toString()"/>--> <!--主鍵自增回寫方法,默認值CALL IDENTITY(),適應於大多數數據庫--> <!--<property name="IDENTITY" value="CALL IDENTITY()"/>--> <!--主鍵自增回寫方法執行順序,默認AFTER,可選值爲(BEFORE|AFTER)--> <!--<property name="ORDER" value="AFTER"/>--> </plugin> </plugins>

可配置參數通常狀況下不須要修改,直接像下面這樣一行便可:

<plugin interceptor="com.github.abel533.mapper.MapperInterceptor"></plugin>

附: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=hsqldb
            reasonable=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配置中

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

<mappers> <mapper class="com.github.abel533.mapper.CountryMapper" /> <mapper class="com.github.abel533.mapper.Country2Mapper" /> <mapper class="com.github.abel533.mapper.CountryTMapper" /> <mapper class="com.github.abel533.mapper.CountryUMapper" /> <mapper class="com.github.abel533.mapper.CountryIMapper" /> <mapper class="com.github.abel533.mapper.UserInfoMapper" /> <mapper class="com.github.abel533.mapper.UserLoginMapper" /> <mapper class="com.github.abel533.mapper.UserLogin2Mapper" /> </mappers>

附:Spring配置相關

若是你在Spring中配置Mapper接口,不須要像上面這樣一個個配置,只須要有下面的這個掃描Mapper接口的這個配置便可:

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <property name="basePackage" value="com.isea533.mybatis.mapper"/> </bean>

6. 代碼中使用

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

SqlSession sqlSession = MybatisHelper.getSqlSession(); try { //獲取Mapper UserInfoMapper 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是當前的ID Assert.assertEquals(6, (int)userInfo.getId()); //經過主鍵刪除新增的數據 Assert.assertEquals(1,mapper.deleteByPrimaryKey(userInfo)); } finally { sqlSession.close(); }

另外一個例子:

SqlSession sqlSession = MybatisHelper.getSqlSession(); try { //獲取Mapper CountryMapper mapper = sqlSession.getMapper(CountryMapper.class); //查詢總數 Assert.assertEquals(183, mapper.selectCount(new Country())); //查詢100 Country 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(); }