Mybatis 實現(xiàn)動態(tài)組裝查詢條件,仿SQL模式
更新時間：2021年06月10日 10:15:43 作者：狂奔岻蝸牛
這篇文章主要介紹了Mybatis 實現(xiàn)動態(tài)組裝查詢條件，仿SQL模式的操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
目的：
以前比較習(xí)慣使用Hibernate，后來覺得mybatis不能按我想要的自動組裝為SQL查詢條件，所以提供該工具類；
效果圖：
如圖所示，根據(jù)條件自動組裝查詢條件，下面來說一下實現(xiàn)方法：
1. ServiceImpl書寫注意項
Page<SysLogin> resultPage = null;
try {
PageHelper.startPage(pager.getCurrentPage(), pager.getPageSize());
// 判斷是否有分頁
if (ObjectHelper.isNotEmpty(pager.getDirection())
&& ObjectHelper.isNotEmpty(pager.getProperties())) {
specification.addOrderBy(pager.getProperties(),
pager.getDirection());
}
// 判斷是否存在邏輯刪除篩選
String sqlStr = specification.sql();
if (sqlStr.indexOf("deleted") == -1) {
specification.eq("deleted", "0");
}
resultPage = this.sysLoginMapper.page(specification.sql());
} catch (Exception e) {
result = Result.newFailure("數(shù)據(jù)錯誤", "在獲取分頁列表時發(fā)生異常。");
log.error(SimpleLogFormater.formatException(result.getMessage(), e));
return result;
}
2. Mapper.java 書寫
查詢條件非Map對象，直接就是SQL語句了；
/**
* 分頁查詢數(shù)據(jù)
*
* @return
*/
Page<T> page(String sqlStr);
3. 關(guān)于XML的配置，會拼裝SQL語句
附：SQL拼裝工具類
/**
* @Description: (用一句話描述該文件做什么)
* @author heliang
* @date 2018-7-6 下午6:43:42
* @version V2.1
*/
package com.onem2.base.common;
import com.onem2.base.helper.ObjectHelper;
/**
* @ClassName: Specification
* @Description: (這里用一句話描述這個類的作用)
* @author heliang
* @date 2018-7-6 下午6:43:42
* @version V2.1 * Update Logs: * Name: * Date: * Description: 初始化
*/
public class Specification {
private StringBuilder where = new StringBuilder();
private String groupBy;
private String having;
private String orderBy;
public StringBuilder getWhere() {
return where;
}
public void setWhere(StringBuilder where) {
this.where = where;
}
public String getGroupBy() {
return groupBy;
}
public void setGroupBy(String groupBy) {
this.groupBy = groupBy;
}
public String getHaving() {
return having;
}
public void setHaving(String having) {
this.having = having;
}
public String getOrderBy() {
return orderBy;
}
public void setOrderBy(String orderBy) {
this.orderBy = orderBy;
}
public Specification addOrderBy(String sort, String order) {
if (!isEmpty(sort) && !isEmpty(order)) {
this.orderBy = ObjectHelper.underscoreName(sort) + " " + order;
}
return this;
}
public Specification orLike(String value, String columns) {
if (!isEmpty(value)) {
StringBuffer strBuf = new StringBuffer("");
for (String column : columns.split(",")) {
strBuf.append(ObjectHelper.underscoreName(column) + " like '%"
+ value + "%' or ");
}
String orLikeStr = strBuf.substring(0, strBuf.lastIndexOf("or"));
where.append(" and (" + orLikeStr + ")");
}
return this;
}
public Specification eq(String column, String value) {
if (!isEmpty(value)) {
where.append(" and " + ObjectHelper.underscoreName(column) + " = '"
+ sqlParam(value) + "'");
}
return this;
}
public Specification ne(String column, String value) {
if (!isEmpty(value)) {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " != '" + sqlParam(value) + "'");
}
return this;
}
public Specification like(String column, String value) {
if (!isEmpty(value)) {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " like '%" + sqlParam(value) + "%'");
}
return this;
}
public Specification notLike(String column, String value) {
if (!isEmpty(value)) {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " not like '%" + sqlParam(value) + "%'");
}
return this;
}
public Specification in(String column, String... values) {
if (!isEmpty(values)) {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " in (" + inValuesString(values) + ")");
}
return this;
}
public Specification notIn(String column, String... values) {
if (!isEmpty(values)) {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " not in (" + inValuesString(values) + ")");
}
return this;
}
public Specification gt(String column, String value) {
if (!isEmpty(value)) {
where.append(" and " + ObjectHelper.underscoreName(column) + " > '"
+ sqlParam(value) + "'");
}
return this;
}
public Specification gte(String column, String value) {
if (!isEmpty(value)) {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " >= '" + sqlParam(value) + "'");
}
return this;
}
public Specification lt(String column, String value) {
if (!isEmpty(value)) {
where.append(" and " + ObjectHelper.underscoreName(column) + " < '"
+ sqlParam(value) + "'");
}
return this;
}
public Specification lte(String column, String value) {
if (!isEmpty(value)) {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " <= '" + sqlParam(value) + "'");
}
return this;
}
public Specification between(String column, String from, String to) {
if (isEmpty(from) && isEmpty(to)) {
return this;
}
if (isEmpty(to)) {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " >= '" + sqlParam(from) + "'");
} else if (isEmpty(from)) {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " <= '" + sqlParam(to) + "'");
} else {
where.append(" and " + ObjectHelper.underscoreName(column)
+ " between '" + sqlParam(from) + "' and '" + sqlParam(to)
+ "'");
}
return this;
}
public String sql() {
StringBuilder sql = new StringBuilder("");
final int a = 4;
final int b = 5;
if (where.length() > a) {
sql.append(" " + where.substring(b));
}
if (!isEmpty(groupBy)) {
sql.append(" group by " + groupBy);
}
if (!isEmpty(having)) {
sql.append(" having " + having);
}
if (!isEmpty(orderBy)) {
sql.append(" order by " + orderBy);
}
return sql.toString();
}
public String toString() {
return sql();
}
private static boolean isEmpty(String value) {
return value == null || "".equals(value) || value.trim().length() == 0;
}
private static boolean isEmpty(String[] values) {
if (values == null || values.length == 0) {
return true;
}
for (String value : values) {
if (!isEmpty(value)) {
return false;
}
}
return true;
}
private static String inValuesString(String[] values) {
StringBuilder string = new StringBuilder();
for (String value : values) {
if (isEmpty(value)) {
continue;
}
string.append('\'');
string.append(value);
string.append('\'');
string.append(',');
}
if (string.length() > 0) {
string.deleteCharAt(string.length() - 1);
}
return string.toString();
}
private static String sqlParam(String sqlParam) {
return sqlParam.replaceAll("([';]+|(--)+)", "");
}
}
附：ObjectHelper 工具源碼:
package com.onem2.base.helper;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
/**
* Object幫助類 功能：此類提供處理 <Object>對象一系列方法
*
* @author 賀亮
*
*/
public class ObjectHelper {
/**
* 將id數(shù)組轉(zhuǎn)換為id集合
*
* @param ids
* @return
*/
public static List<Long> initIds(String[] ids) {
List<Long> list = new ArrayList<Long>();
list.add(-1L);
for (int i = 0; i < ids.length; i++) {
list.add(Long.valueOf(ids[i]));
}
return list;
}
/**
* 組裝條件
*
* @param str
* @return
*/
public static List<String> strToList(String str) {
if (isEmpty(str)) {
return null;
}
String[] strs = str.split(",");
List<String> list = new ArrayList<String>();
for (int i = 0; i < strs.length; i++) {
list.add(strs[i]);
}
return list;
}
/**
* 判斷這個Object是否為Null或長度為0
*
* @param obj
* @return
*/
public static boolean isEmpty(Object obj) {
if (obj == null) {
return true;
}
if (obj instanceof Collection) {
return ((Collection<?>) obj).isEmpty();
}
if (obj instanceof String) {
return ((String) obj).equalsIgnoreCase("null")
| ((String) obj).trim().toString().equals("");
}
if (obj instanceof StringBuffer) {
return ((StringBuffer) obj).length() == 0;
}
if (obj.getClass().isArray()) {
try {
Object[] a = (Object[]) obj;
boolean b = true;
for (Object o : a) {
b = b & isEmpty(o);
if (!b) {
break;
}
}
return b;
} catch (ClassCastException e) {
}
}
return false;
}
/**
* 判斷這個Object是否不為Null或長度不為0
*
* @param obj
* @return
*/
public static boolean isNotEmpty(Object obj) {
return !isEmpty(obj);
}
/**
* 返回首字母大寫單詞
*
* @param str
* @return
*/
public static String lcyFirstLetterToUpper(String str) {
return str.replaceFirst(str.substring(0, 1), str.substring(0, 1)
.toUpperCase());
}
/**
* 轉(zhuǎn)換為下劃線
*
* @param camelCaseName
* @return
*/
public static String underscoreName(String camelCaseName) {
StringBuilder result = new StringBuilder();
if (camelCaseName != null && camelCaseName.length() > 0) {
result.append(camelCaseName.substring(0, 1).toLowerCase());
for (int i = 1; i < camelCaseName.length(); i++) {
char ch = camelCaseName.charAt(i);
if (Character.isUpperCase(ch)) {
result.append("_");
result.append(Character.toLowerCase(ch));
} else {
result.append(ch);
}
}
}
return result.toString();
}
/**
* 轉(zhuǎn)換為駝峰
*
* @param underscoreName
* @return
*/
public static String camelCaseName(String underscoreName) {
StringBuilder result = new StringBuilder();
if (underscoreName != null && underscoreName.length() > 0) {
boolean flag = false;
for (int i = 0; i < underscoreName.length(); i++) {
char ch = underscoreName.charAt(i);
if ("_".charAt(0) == ch) {
flag = true;
} else {
if (flag) {
result.append(Character.toUpperCase(ch));
flag = false;
} else {
result.append(ch);
}
}
}
}
return result.toString();
}
public static void main(String[] args) {
System.out.println(underscoreName("loginName"));
}
}
這樣就可以做到動態(tài)生成查詢條件，復(fù)雜的查詢條件也不會去改動XML配置了。
mybatis原理:參數(shù)解析與SQL動態(tài)組裝過程
mybatis執(zhí)行sql之前， 需要經(jīng)過參數(shù)解析、sql動態(tài)組裝等過程，本文主要聊聊mybatis的：
（1）參數(shù)解析原理及其過程
（2）sql動態(tài)組裝原理及其過程
一、數(shù)據(jù)準(zhǔn)備
1.實體類，省略了set、get方法
public class User {
private String id;
private String username;
private String password;
private Integer isValid;
}
2.mapper接口UserMapper，可以看作是一個根據(jù)用戶名和密碼的登錄接口
User getUserByUsernameAndPassword(@Param("name") String username, @Param("pwd") String password);
3.mapper映射
<select id="getUserByUsernameAndPassword" resultType="com.qxf.pojo.User">
select id,username,password,is_valid as isValid from t_user
<where>
<if test="name != null and name != ''">
username = #{name}
</if>
<if test="pwd != null and pwd != ''">
and password = #{pwd}
</if>
</where>
</select>
4.測試，mybatis-config.xml配置文件按一般配置即可，這里就不貼代碼了
//讀取配置信息
InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
//根據(jù)配置信息，創(chuàng)建SqlSession工廠
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(inputStream);
//SqlSession工廠創(chuàng)建SqlSession
SqlSession sqlSession = factory.openSession();
//獲取接口的代理對象
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
//執(zhí)行相應(yīng)的接口方法
User user = mapper.getUserByUsernameAndPassword("張三2", null);
System.out.println(user);
下面將以這句代碼為入口：
（注意，這里只是為了測試，給密碼參數(shù)傳遞了null，正常情況不會這樣傳遞參數(shù)的，不然結(jié)果返回一個List集合就會報錯的）
//執(zhí)行相應(yīng)的接口方法
User user = mapper.getUserByUsernameAndPassword("張三2", null);
二、參數(shù)解析原理及其過程
首先要明白一點，返回的是mapper接口的代理對象，所以會來到MapperProxy的invoke方法
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
try {
// Object對象的方法，則直接執(zhí)行
if (Object.class.equals(method.getDeclaringClass())) {
return method.invoke(this, args);
}
if (method.isDefault()) {
return this.invokeDefaultMethod(proxy, method, args);
}
} catch (Throwable var5) {
throw ExceptionUtil.unwrapThrowable(var5);
}
// 獲取mapperMethod，這里面就會進行參數(shù)解析
MapperMethod mapperMethod = this.cachedMapperMethod(method);
// 執(zhí)行方法
return mapperMethod.execute(this.sqlSession, args);
}
重點關(guān)注這句：
// 獲取mapperMethod，這里面就會進行參數(shù)解析
MapperMethod mapperMethod = this.cachedMapperMethod(method);
參數(shù)的解析可以分成兩部：
（1）形參的解析
（2）實參的封裝
（1）形成的解析
一路跟進去，最終會來到 ParamNameResolver，暫且叫做參數(shù)名稱解析器吧，首先會在構(gòu)造器組裝參數(shù)的位置和名稱的對應(yīng)關(guān)系，如果我們使用了@Param注解，則會使用我們定義的名稱，否則會使用arg0、arg1....依次替代，詳細代碼如下：
public ParamNameResolver(Configuration config, Method method) {
// 獲取參數(shù)列表中，每一個參數(shù)的類型
Class<?>[] paramTypes = method.getParameterTypes();
// 獲取參數(shù)注解，因為每個參數(shù)可能有多個注解，所以是二維數(shù)組
Annotation[][] paramAnnotations = method.getParameterAnnotations();
// 存放結(jié)果的map
SortedMap<Integer, String> map = new TreeMap();
// 參數(shù)個數(shù)
int paramCount = paramAnnotations.length;
for(int paramIndex = 0; paramIndex < paramCount; ++paramIndex) {
if (!isSpecialParameter(paramTypes[paramIndex])) {
// 參數(shù)名稱
String name = null;
// 參數(shù)的注解數(shù)組
Annotation[] var9 = paramAnnotations[paramIndex];
// 參數(shù)注解的個數(shù)
int var10 = var9.length;
// 遍歷每個注解，找到Param注解，拿到value作為參數(shù)名稱
for(int var11 = 0; var11 < var10; ++var11) {
Annotation annotation = var9[var11];
if (annotation instanceof Param) {
this.hasParamAnnotation = true;
name = ((Param)annotation).value();
break;
}
}
if (name == null) {
if (config.isUseActualParamName()) {
name = this.getActualParamName(method, paramIndex);
}
if (name == null) {
name = String.valueOf(map.size());
}
}
// 參數(shù)序號作為key，從0開始，參數(shù)名稱作為值
map.put(paramIndex, name);
}
}
// 沒有做什么，再一次封裝而已
this.names = Collections.unmodifiableSortedMap(map);
}
結(jié)果是這樣的：符合我們的預(yù)期的
（2）實參的封裝
然后會來到getNamedParams方法對參數(shù)進一步的封裝：
public Object getNamedParams(Object[] args) {
// 參數(shù)個數(shù)，這個names就是上面解析后的map，key是從0開始的參數(shù)序號，value是參數(shù)名稱
int paramCount = this.names.size();
// 這里的args便是實參列表
// 實參不為空，形參個數(shù)不為0
if (args != null && paramCount != 0) {
if (!this.hasParamAnnotation && paramCount == 1) {
// 沒有使用@Param注解，并且只有一個參數(shù)
return args[(Integer)this.names.firstKey()];
} else {
// 將參數(shù)封裝成一個map
Map<String, Object> param = new ParamMap();
int i = 0;
// 對形參循環(huán)迭代
for(Iterator var5 = this.names.entrySet().iterator(); var5.hasNext(); ++i) {
Entry<Integer, String> entry = (Entry)var5.next();
// names中的參數(shù)名稱為key，值為實參值
param.put((String)entry.getValue(), args[(Integer)entry.getKey()]);
// 并添加key為param1、param2之類的通用參數(shù)
String genericParamName = "param" + String.valueOf(i + 1);
if (!this.names.containsValue(genericParamName)) {
param.put(genericParamName, args[(Integer)entry.getKey()]);
}
}
return param;
}
} else {
return null;
}
}
通過源碼可以發(fā)現(xiàn)，
（1）如果只有一個參數(shù)，并且沒有使用@Param注解，就直接返回第一個參數(shù)
（2）有多個參數(shù)，則封裝成一個map，key為參數(shù)參數(shù)名稱，使用了@Param注解，名稱就是注解中的值，否則key為arg0、arg1這種類型，同時，一定含有key為param1、param2的參數(shù)，值就是傳入的值
封裝后的結(jié)果如下：
這樣就完成了參數(shù)的解析過程，總結(jié)一下：
（1）解析形參，判斷是否使用了@Param注解
（2）封裝實參，如果只有一個，并且沒有使用@Param注解，就直接返回第一個參數(shù)值，否則封裝成map
三、動態(tài)組裝sql原理及其過程
來到CachingExecutor的如下方法，作為入口：
public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
// 獲取組裝完成的sql
BoundSql boundSql = ms.getBoundSql(parameterObject);
// 創(chuàng)建緩存key
CacheKey key = this.createCacheKey(ms, parameterObject, rowBounds, boundSql);
// 執(zhí)行查詢
return this.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
}
重點看這句：
// 獲取組裝完成的sql
BoundSql boundSql = ms.getBoundSql(parameterObject);
一路跟進去，來到DynamicSqlSource的getBoundSql方法：
public BoundSql getBoundSql(Object parameterObject) {
// 將參數(shù)封裝成動態(tài)上下文，DynamicContext中sqlBuilder就是最后組裝的sql
DynamicContext context = new DynamicContext(this.configuration, parameterObject);
// 根據(jù)條件，動態(tài)組裝sql
this.rootSqlNode.apply(context);
SqlSourceBuilder sqlSourceParser = new SqlSourceBuilder(this.configuration);
Class<?> parameterType = parameterObject == null ? Object.class : parameterObject.getClass();
// 將#{參數(shù)}替換為?
SqlSource sqlSource = sqlSourceParser.parse(context.getSql(), parameterType, context.getBindings());
BoundSql boundSql = sqlSource.getBoundSql(parameterObject);
Map var10000 = context.getBindings();
Objects.requireNonNull(boundSql);
var10000.forEach(boundSql::setAdditionalParameter);
return boundSql;
}
我們先看下這句：
// 根據(jù)條件，動態(tài)組裝sql this.rootSqlNode.apply(context);
對于我們的sql：
<select id="getUserByUsernameAndPassword" resultType="com.qxf.pojo.User">
select id,username,password,is_valid as isValid from t_user
<where>
<if test="name != null and name != ''">
username = #{name}
</if>
<if test="pwd != null and pwd != ''">
and password = #{pwd}
</if>
</where>
</select>
每個標(biāo)簽都有對應(yīng)的SqlNode來處理，比如if標(biāo)簽，就由IfSqlNode來處理，where標(biāo)簽，則會通過TrimSqlNode來處理，SqlNode的具體實現(xiàn)類如下：
這里以IfSqlNode處理if標(biāo)簽為例：
這是就是兩步：
（1）判斷表達式的值是否為真，這里最終使用的是Ognl來判斷
（2）如果表達式的為真，就將標(biāo)簽內(nèi)容追加到sql中去
處理結(jié)果如下：
因為密碼的參數(shù)傳入為null，所以不會拼接密碼查詢條件，只拼接了用戶名查詢條件
然后是將#{參數(shù)}替換為?進行占位：
// 將#{參數(shù)}替換為?
SqlSource sqlSource = sqlSourceParser.parse(context.getSql(), parameterType, context.getBindings());
這個就比較簡單了，可以自行看源碼，最終是這樣的：
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
Mybatis一級緩存和結(jié)合Spring Framework后失效的源碼探究
這篇文章主要介紹了Mybatis一級緩存和結(jié)合Spring Framework后失效的源碼探究,本文給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-04-04
在這篇文章當(dāng)中我們主要介紹實現(xiàn)一個非常簡易版的線程池，深入的去理解其中的原理，麻雀雖小，五臟俱全，感興趣的小伙伴快跟隨小編一起學(xué)習(xí)學(xué)習(xí)吧2022-10-10
使用String類型小數(shù)值轉(zhuǎn)換為Long類型
這篇文章主要介紹了使用String類型小數(shù)值轉(zhuǎn)換為Long類型操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
這篇文章主要介紹了SpringBoot集成JWT令牌詳細說明,JWT方式校驗方式更加簡單便捷化，無需通過redis緩存，而是直接根據(jù)token取出保存的用戶信息，以及對token可用性校驗，單點登錄，驗證token更為簡單,需要的朋友可以參考下2023-10-10
SpringBoot集成內(nèi)存數(shù)據(jù)庫hsqldb的實踐
hsqldb只需要添加對應(yīng)的依賴，然后在配置文件進行配置。不需要安裝一個數(shù)據(jù)庫，本文就來介紹一下具體使用，感興趣的可以了解一下2021-09-09
SpringBoot整合SpringSecurity實現(xiàn)認證攔截的教程
我們寫的任何一個項目，都應(yīng)該有安全防護，不應(yīng)該讓這個項目進行“裸奔”，否則很容易被別人進行攻擊。而在SpringBoot環(huán)境中，其實可以很容易實現(xiàn)安全保護，本文給大家介紹SpringBoot如何整合SpringSecurity實現(xiàn)認證攔截,需要的朋友可以參考下2023-05-05
springboot設(shè)置了server.port但是沒有用,還是8080問題
這篇文章主要介紹了springboot設(shè)置了server.port但是沒有用,還是8080問題的解決，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-12-12
GC算法實現(xiàn)篇之并發(fā)標(biāo)記清除
這篇文章主要為大家介紹了GC算法實現(xiàn)篇之并發(fā)-標(biāo)記-清除,?CMS垃圾收集器在減少停頓時間上做了很多給力的工作,?大量的并發(fā)線程執(zhí)行的工作并不需要暫停應(yīng)用線程2022-01-01
這篇文章主要介紹了mybatis if test條件判斷語句中的判斷問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-03-03
Java中有一維數(shù)組，二維數(shù)組以及多維數(shù)組，在這篇文章中，將給大家詳細介紹一下如何正確使用Java中的二維數(shù)組，感興趣的小伙伴跟著小編一起學(xué)習(xí)吧2023-05-05