一、Mybatis的不足之處
Mybatis是一款優(yōu)秀的及其靈活的持久層框架,通過XML配置并映射到Mapper接口為Service層提供基礎(chǔ)數(shù)據(jù)操作入口赦肋。
這么優(yōu)秀的框架竟然還有不足之處第队?
俗話說人無完人,因?yàn)镸ybatis實(shí)在是太靈活了蘑志,靈活到每個(gè)Mapper接口都需要定制對應(yīng)的XML累奈,所以就會(huì)引發(fā)一些問題贬派。
問題一:配置文件繁多
假如一個(gè)系統(tǒng)中DB中涉及100張表,我們就需要寫100
個(gè)Mapper接口澎媒,還沒完搞乏,最可怕的是,我們要為這100
個(gè)Mapper接口定制與之對應(yīng)的100
套XML戒努。而每個(gè)Mapper都必不可少的需要增刪改查功能请敦,我們就要寫100
遍增刪改查,作為高貴的Java開發(fā)工程師储玫,這是不能容忍的侍筛,于是Mybatis Generator
誕生了,然而又會(huì)引發(fā)另一個(gè)問題撒穷!
問題二:維護(hù)困難
我們使用Mybatis Generator
解決了問題一匣椰,再多的文件生成就是了,簡單粗暴端礼,貌似解決了所有的問題禽笑,Mybatis完美了!
不要高興的太早蛤奥,在系統(tǒng)剛剛建立起來時(shí)聋丝,我們使用Mybatis Generator
生成了一堆XML扣蜻,在開發(fā)過程中,產(chǎn)品忽然提了一個(gè)新的需求,項(xiàng)目經(jīng)理根據(jù)這個(gè)需求在某張表中增加或變動(dòng)了一個(gè)字段求类,這時(shí)碳柱,我猜你的操作是這樣:
- 1藤滥、找到對應(yīng)表的XML
- 2梗搅、將該XML中自定義的一段標(biāo)簽復(fù)制出來,保存在本地
- 3拷恨、使用
Mybatis Generator
重新生成該表的XML - 4脖律、將之覆蓋當(dāng)前的XML
- 5、將自定義的一段標(biāo)簽再粘貼進(jìn)新的XML中
在這個(gè)過程中腕侄,如果我們在第2步時(shí)漏復(fù)制了一段標(biāo)簽小泉,等整個(gè)操作完成之后,又別是一番滋味在心頭~
問題三:編寫XML困難
假如肝不錯(cuò)冕杠,問題二也是小CASE微姊,那么問題又來了,我們?nèi)绾卧诜遍L的XML中去編寫和修改我們的XML呢分预。
當(dāng)我們打開要編輯的XML兢交,映入眼簾的就是1000多行的XML,其中900行都是通用的增刪改查操作笼痹,要新增一個(gè)標(biāo)簽配喳,我們需要拉至文件底部編寫新的數(shù)據(jù)操作酪穿,要更新一個(gè)標(biāo)簽,我們需要通過Ctrl + F
尋找目標(biāo)標(biāo)簽再進(jìn)行修改晴裹。
如何避免這些問題呢被济?
如何讓Mybatis增強(qiáng)通用性又不失靈活呢?
二涧团、使用Ourbatis輔助Mybatis
Ourbatis是一款Mybatis開發(fā)增強(qiáng)工具只磷,小巧簡潔,項(xiàng)目地址:
- Github:https://github.com/ainilili/ourbatis
- Gitee:https://gitee.com/ainilili/ourbatis
- Wiki:https://github.com/ainilili/ourbatis/wiki
- Demo:https://github.com/ainilili/ourbatis-simple
特性:
- 1泌绣、簡潔方便钮追,可以讓Mybatis無XML化開發(fā)。
- 2阿迈、優(yōu)雅解耦元媚,通用和自定義的SQL標(biāo)簽完全隔離,讓維護(hù)更加輕松苗沧。
- 3惠毁、無侵入性,Mybatis和Ourbatis可同時(shí)使用崎页,配置簡潔。
- 4腰埂、靈活可控飒焦,通用模板可自定義及擴(kuò)展。
- 5屿笼、部署快捷牺荠,只需要一個(gè)依賴,兩個(gè)配置驴一,即可直接運(yùn)行休雌。
- 6、多數(shù)據(jù)源肝断,在多數(shù)據(jù)源環(huán)境下也可以照常使用杈曲。
關(guān)于Ourbatis使用的一個(gè)小Demo
環(huán)境:
- Spring Boot 2.0.5.RELEASE
- Ourbatis 1.0.5
- JAVA 8
- Mysql
以Spring Boot 2.0.5.RELEASE
版本為例,在可以正常使用Mybatis的項(xiàng)目中胸懈,pom.xml
添加如下依賴:
<dependency>
<groupId>com.smallnico</groupId>
<artifactId>ourbatis-spring-boot-starter</artifactId>
<version>1.0.5</version>
</dependency>
在配置文件中增加一下配置:
ourbatis.domain-locations=實(shí)體類所在包名
接下來担扑,Mapper接口只需要繼承SimpleMapper
即可:
import org.nico.ourbatis.domain.User;
public interface UserMapper extends SimpleMapper<User, Integer>{
}
至此,一個(gè)使用Ourbatis的簡單應(yīng)用已經(jīng)部署起來了趣钱,之后涌献,你就可以使用一些Ourbatis默認(rèn)的通用操作方法:
public T selectById(K key);
public T selectEntity(T condition);
public List<T> selectList(T condition);
public long selectCount(Object condition);
public List<T> selectPage(Page<Object> page);
default PageResult<T> selectPageResult(Page<Object> page){
long total = selectCount(page.getEntity());
List<T> results = null;
if(total > 0) {
results = selectPage(page);
}
return new PageResult<>(total, results);
}
public K selectId(T condition);
public List<K> selectIds(T condition);
public int insert(T entity);
public int insertSelective(T entity);
public int insertBatch(List<T> list);
public int update(T entity);
public int updateSelective(T entity);
public int updateBatch(List<T> list);
public int delete(T condition);
public int deleteById(K key);
public int deleteBatch(List<K> list);
Mapper自定義方法
在很多場景中,我們使用以上的自帶的通用方法遠(yuǎn)遠(yuǎn)不能滿足我們的需求首有,我們往往需要額外擴(kuò)展新的Mapper方法燕垃、XML標(biāo)簽枢劝,我們使用了Ourbatis之后該如何實(shí)現(xiàn)呢?
首先看一下我們的需求卜壕,在上述Demo中您旁,我們在UserMapper中增加一個(gè)方法selectNameById
:
import org.nico.ourbatis.domain.User;
public interface UserMapper extends SimpleMapper<User, Integer>{
public String selectNameById(Integer userId);
}
和Mybatis一樣,需要在resources
資源目錄下新建一個(gè)文件夾ourbatis-mappers
印叁,然后在其中新建一個(gè)XML文件被冒,命名規(guī)則為:
DomainClassSimpleName + Mapper.xml
其中DomainClassSimpleName
就是我們實(shí)體類的類名,這里是為User
轮蜕,那么新建的XML名為UserMapper.xml
昨悼。
src/main/resources
- ourbatis-mappers
- UserMapper.xml
之后,打開UserMapper.xml
跃洛,開始編寫Mapper中selectNameById
方法對應(yīng)的標(biāo)簽:
<select id="selectNameById" resultType="java.lang.String">
select name from user where id = #{userId}
</select>
注意率触,整個(gè)文件中只需要寫標(biāo)簽就行了,其他的什么都不需要汇竭,這是為什么呢葱蝗?深入之后你就會(huì)明白,這里先不多說细燎!
接下來两曼,就沒有接下來了,可以直接使用selectNameById
方法了玻驻。
深入了解Ourbatis
當(dāng)服務(wù)啟動(dòng)的時(shí)候悼凑,Ourbatis首先會(huì)掃描ourbatis.domain-locations
配置包下的所有實(shí)體類,將之映射為與之對應(yīng)的表結(jié)構(gòu)數(shù)據(jù):
然后通過ourbatis.xml
的渲染璧瞬,生成一個(gè)又一個(gè)的XML文件户辫,最后將之重新Build到Mybatis容器中!
整個(gè)過程分為兩個(gè)核心點(diǎn):
- 1嗤锉、映射實(shí)體類為元數(shù)據(jù)
- 2渔欢、使用
ourbatis.xml
渲染元數(shù)據(jù)為XML文件
我會(huì)一一介紹之~
映射實(shí)體類為元數(shù)據(jù)
在映射時(shí),我們要根據(jù)自己數(shù)據(jù)庫字段命名的風(fēng)格去調(diào)整映射規(guī)則瘟忱,就需要在第1個(gè)核心點(diǎn)中去做處理奥额,Ourbatis使用包裝器來完成:
public interface Wrapper<T> {
public String wrapping(T value);
}
對于需要映射的字段,如表名和表字段名酷誓,它們都將會(huì)經(jīng)過一個(gè)包裝器鏈條的處理之后再投入到ourbatis.xml
中做渲染披坏,這樣就使得我們可以自定義包裝器出更換映射的字段格式,具體方式可以參考官方Wiki:Wrapper包裝器
使用ourbatis.xml
渲染元數(shù)據(jù)為XML文件
而在于第2個(gè)核心點(diǎn)中盐数,Ourbatis通過自定義標(biāo)簽做模板渲染棒拂,我們可以先看一下官方默認(rèn)的ourbatis.xml
內(nèi)部構(gòu)造:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="@{mapperClassName}">
<resultMap id="BaseResultMap" type="@{domainClassName}">
<ourbatis:foreach list="primaryColumns" var="elem">
<id column="@{elem.jdbcName}" property="@{elem.javaName}" />
</ourbatis:foreach>
<ourbatis:foreach list="normalColumns" var="elem">
<result column="@{elem.jdbcName}" property="@{elem.javaName}" />
</ourbatis:foreach>
</resultMap>
<sql id="Base_Column_List">
<ourbatis:foreach list="allColumns" var="elem"
split=",">
`@{elem.jdbcName}`
</ourbatis:foreach>
</sql>
<select id="selectById" parameterType="java.lang.Object"
resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from @{tableName}
where 1 = 1
<ourbatis:foreach list="primaryColumns" var="elem">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</ourbatis:foreach>
</select>
<select id="selectEntity" parameterType="@{domainClassName}"
resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from @{tableName}
where 1 = 1
<ourbatis:foreach list="allColumns" var="elem">
<if test="@{elem.javaName} != null">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</if>
</ourbatis:foreach>
limit 1
</select>
<select id="selectCount" parameterType="@{domainClassName}"
resultType="long">
select count(0)
from @{tableName}
where 1 = 1
<ourbatis:foreach list="allColumns" var="elem">
<if test="@{elem.javaName} != null">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</if>
</ourbatis:foreach>
limit 1
</select>
<select id="selectPage"
parameterType="org.nico.ourbatis.entity.Page"
resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from @{tableName}
where 1 = 1
<if test="entity != null">
<ourbatis:foreach list="allColumns" var="elem">
<if test="entity.@{elem.javaName} != null">
and `@{elem.jdbcName}` = #{entity.@{elem.javaName}}
</if>
</ourbatis:foreach>
</if>
<if test="orderBy != null">
order by ${orderBy}
</if>
<if test="start != null and end != null">
limit ${start},${end}
</if>
</select>
<select id="selectList" parameterType="@{domainClassName}"
resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from @{tableName}
where 1 = 1
<ourbatis:foreach list="allColumns" var="elem">
<if test="@{elem.javaName} != null">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</if>
</ourbatis:foreach>
</select>
<select id="selectId" parameterType="@{domainClassName}"
resultType="java.lang.Object">
select
<ourbatis:foreach list="primaryColumns" var="elem"
split=",">
`@{elem.jdbcName}`
</ourbatis:foreach>
from @{tableName}
where 1 = 1
<ourbatis:foreach list="allColumns" var="elem">
<if test="@{elem.javaName} != null">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</if>
</ourbatis:foreach>
limit 1
</select>
<select id="selectIds" parameterType="@{domainClassName}"
resultType="java.lang.Object">
select
<ourbatis:foreach list="primaryColumns" var="elem"
split=",">
`@{elem.jdbcName}`
</ourbatis:foreach>
from @{tableName}
where 1 = 1
<ourbatis:foreach list="normalColumns" var="elem">
<if test="@{elem.javaName} != null">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</if>
</ourbatis:foreach>
</select>
<delete id="deleteById" parameterType="java.lang.Object">
delete
from @{tableName}
where 1=1
<ourbatis:foreach list="primaryColumns" var="elem">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</ourbatis:foreach>
</delete>
<insert id="insert" keyProperty="@{primaryColumns.0.jdbcName}"
useGeneratedKeys="true" parameterType="@{domainClassName}">
insert into @{tableName}
(
<include refid="Base_Column_List" />
)
values (
<ourbatis:foreach list="allColumns" var="elem"
split=",">
#{@{elem.javaName}}
</ourbatis:foreach>
)
</insert>
<insert id="insertSelective"
keyProperty="@{primaryColumns.0.jdbcName}" useGeneratedKeys="true"
parameterType="@{domainClassName}">
insert into @{tableName}
(
<ourbatis:foreach list="primaryColumns" var="elem"
split=",">
`@{elem.jdbcName}`
</ourbatis:foreach>
<ourbatis:foreach list="normalColumns" var="elem">
<if test="@{elem.javaName} != null">
,`@{elem.jdbcName}`
</if>
</ourbatis:foreach>
)
values (
<ourbatis:foreach list="primaryColumns" var="elem">
#{@{elem.javaName}}
</ourbatis:foreach>
<ourbatis:foreach list="normalColumns" var="elem">
<if test="@{elem.javaName} != null">
, #{@{elem.javaName}}
</if>
</ourbatis:foreach>
)
</insert>
<insert id="insertBatch"
keyProperty="@{primaryColumns.0.jdbcName}" useGeneratedKeys="true"
parameterType="java.util.List">
insert into @{tableName}
(
<include refid="Base_Column_List" />
)
values
<foreach collection="list" index="index" item="item"
separator=",">
(
<ourbatis:foreach list="allColumns" var="elem"
split=",">
#{item.@{elem.javaName}}
</ourbatis:foreach>
)
</foreach>
</insert>
<update id="update" parameterType="@{domainClassName}">
update @{tableName}
<set>
<ourbatis:foreach list="normalColumns" var="elem"
split=",">
`@{elem.jdbcName}` = #{@{elem.javaName}}
</ourbatis:foreach>
</set>
where 1=1
<ourbatis:foreach list="primaryColumns" var="elem">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</ourbatis:foreach>
</update>
<update id="updateSelective" parameterType="@{domainClassName}">
update @{tableName}
<set>
<ourbatis:foreach list="primaryColumns" var="elem"
split=",">
`@{elem.jdbcName}` = #{@{elem.javaName}}
</ourbatis:foreach>
<ourbatis:foreach list="normalColumns" var="elem">
<if test="@{elem.javaName} != null">
,`@{elem.jdbcName}` = #{@{elem.javaName}}
</if>
</ourbatis:foreach>
</set>
where 1=1
<ourbatis:foreach list="primaryColumns" var="elem">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</ourbatis:foreach>
</update>
<update id="updateBatch" parameterType="java.util.List">
<foreach collection="list" index="index" item="item"
separator=";">
update @{tableName}
<set>
<ourbatis:foreach list="normalColumns" var="elem"
split=",">
`@{elem.jdbcName}` = #{item.@{elem.javaName}}
</ourbatis:foreach>
</set>
where 1=1
<ourbatis:foreach list="primaryColumns" var="elem">
and `@{elem.jdbcName}` = #{item.@{elem.javaName}}
</ourbatis:foreach>
</foreach>
</update>
<delete id="deleteBatch" parameterType="java.util.List">
delete from @{tableName} where @{primaryColumns.0.jdbcName} in
<foreach close=")" collection="list" index="index" item="item"
open="(" separator=",">
#{item}
</foreach>
</delete>
<delete id="delete" parameterType="@{domainClassName}">
delete from @{tableName} where 1 = 1
<ourbatis:foreach list="allColumns" var="elem">
<if test="@{elem.javaName} != null">
and `@{elem.jdbcName}` = #{@{elem.javaName}}
</if>
</ourbatis:foreach>
</delete>
<ourbatis:ref path="classpath:ourbatis-mappers/@{domainSimpleClassName}Mapper.xml" />
</mapper>
可以看出來,ourbatis.xml
內(nèi)容類似于原生的Mybatis的XML,不同的是帚屉,有兩個(gè)陌生的標(biāo)簽:
- ourbatis:foreach 對元數(shù)據(jù)中的列表進(jìn)行循環(huán)渲染
- ourbatis:ref 引入外界文件內(nèi)容
這是Ourbatis中獨(dú)有的標(biāo)簽谜诫,Ourbatis也提供著對應(yīng)的入口讓我們?nèi)プ远x標(biāo)簽:
Class: org.nico.ourbatis.Ourbatis
Field:
public static final Map<String, AssistAdapter> ASSIST_ADAPTERS = new HashMap<String, AssistAdapter>(){
private static final long serialVersionUID = 1L;
{
put("ourbatis:foreach", new ForeachAdapter());
put("ourbatis:ref", new RefAdapter());
}
};
我們可以修改org.nico.ourbatis.Ourbatis
類中的靜態(tài)參數(shù)ASSIST_ADAPTERS
去刪除、更新和添加自定義標(biāo)簽攻旦,需要實(shí)現(xiàn)一個(gè)標(biāo)簽適配器喻旷,我們可以看一下最簡單的RefAdapter
適配器的實(shí)現(xiàn):
public class RefAdapter extends AssistAdapter{
@Override
public String adapter(Map<String, Object> datas, NoelRender render, Document document) {
String path = render.rending(datas, document.getParameter("path"), "domainSimpleClassName");
String result = StreamUtils.convertToString(path.replaceAll("classpath:", ""));
return result == null ? "" : result.trim();
}
}
Ourbatis中只定義了上述兩個(gè)自定義標(biāo)簽已足夠滿足需求,通過foreach
標(biāo)簽牢屋,將元數(shù)據(jù)中的集合遍歷渲染且预,通過ref
標(biāo)簽引入外界資源,也就是我們之前所說的對Mapper接口中方法的擴(kuò)展烙无!
<ourbatis:ref path="classpath:ourbatis-mappers/@{domainSimpleClassName}Mapper.xml" />
其中的path就是當(dāng)前項(xiàng)目classpath路徑的相對路徑锋谐,而@{domainSimpleClassName}
就代表著實(shí)體類的類名,更多的系統(tǒng)參數(shù)可以參考Wiki:元數(shù)據(jù)映射
通過這種模板渲染的機(jī)制截酷,Ourbatis是相當(dāng)靈活的涮拗,我們不僅可以通過引入外部文件進(jìn)行擴(kuò)展,當(dāng)我們需要添加或修改通用方法時(shí)迂苛,我們可以可以自定義ourbatis.xml
的內(nèi)容三热,如何做到呢?復(fù)制一份將之放在資源目錄下就可以了三幻!
看到這里就漾,相信大家已經(jīng)知道Ourbatis的基本原理已經(jīng)使用方式,我就再次不多說了念搬,更多細(xì)節(jié)可以去官方Wiki中閱讀:Ourbtis Wiki