前言:本文為大家介紹mybatis plus 查詢寫法,以及如何透過自定義註解來解決通用查詢條件過多的問題,請大家多多點贊、收藏、評論、關注哦!
傳統的mybatis plus 查詢寫法對於常規的mybatis單表查詢,我們既可以採用LambdaQueryWrapper查詢,也可以使用QueryWrapper查詢。LambdaQueryWrapper具有防誤寫、規範程式碼等好處,但是缺點是無法在複雜的多表查詢中使用。相比較來說,使用QueryWrapper編寫查詢更加靈活,可以適應更復雜的查詢場景。我們首先看一個QueryWrapper查詢的例子
public List<UserMo> list (UserForm userForm) { QueryWrapper<UserMo> queryWrapper = new QueryWrapper<>(); queryWrapper.like(StringTool.isNotEmpty(userForm.getUserName(), "name", userForm.getUserName()); queryWrapper.eq(StringTool.isNotEmpty(userForm.getMobile(), "mobile", userForm.getMobile()); // 其它的查詢條件... return userMapper.selectList(queryWrapper);}
對於上面的查詢語句來說,可以很好的對前端傳值進行處理,當userForm中有前端傳值的話,就會往SQL語句中加一條where條件。但是這樣做的話會有一個相對來說比較複雜的點,那就是當UserForm中的欄位過於多的時候,我們也許得寫十幾行的這種重複判斷的語句。
透過自定義註解來解決通用查詢條件過多問題透過觀察mybatis plus 對於queryWrapper相關查詢方法的列子,我們可以找出一類通用方法
可以看出來這幾個方法都是傳的同樣的三個引數。我想對於這些簡單的通用的查詢條件,也許可以有一個通用的方法來填充。我首先設定了一個列舉類,將這些查詢條件列出來,並在構造方法中,將對應的方法以反射的方式取到。
public enum QueryConditionEnum { EQ("eq"), NE("ne"), GT("gt"), GE("ge"), LT("lt"), LE("le"), LIKE("like"), NOT_LIKE("notLike"), LIKE_LEFT("likeLeft"), LIKE_RIGHT("likeRight"); private String name; private Method method; QueryConditionEnum (String name) { this.name = name; try { Method method = AbstractWrapper.class.getDeclaredMethod(name, boolean.class, Object.class, Object.class); this.method = method; } catch (NoSuchMethodException e) { } } }
再者,我想透過註解的方式來規定需要以什麼方法填充,預設為EQ,對此寫了一個QueryCondition註解。
@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.FIELD})public @interface QueryCondition { /** * 預設查詢方式 * * @return */ QueryConditionEnum value() default QueryConditionEnum.EQ; /** * 是否填充預設查詢條件 * * @return */ boolean isCondition() default true; }
然後就可以這樣構造UserForm
public class UserForm { private String name; @QueryCondition(QueryConditionEnum.LIKE) private String mobile;}
我們需要一個工具類填充查詢條件,這裡我們新增了一個引數 mo物件,這是因為我們的主查詢物件是Mo物件,Mo物件儲存了相關表格名稱、表格欄位名資訊。
@TableName("user")public class UserMo { @TableField("name") private String name; @TableField("mobile") private String mobile;}
public class QueryTool { /** * 填充預設查詢 * @param baseClazz mo物件class * @param queryWrapper 查詢條件 * @param form 請求物件 */ public static void paddingDefaultConditionQuery(Class baseClazz, QueryWrapper queryWrapper, Object form) { try { for (Field declaredField : form.getClass().getDeclaredFields()) { declaredField.setAccessible(true); Object fieldValue = declaredField.get(form); QueryCondition queryCondition = declaredField.getAnnotation(QueryCondition.class); if (fieldValue == null) { continue; } if (queryCondition == null) { queryWrapper.eq(StringTool.isNotEmpty(fieldValue.toString()), QueryTool.getTableName(baseClazz) + "." + QueryTool.getTableFieldName(baseClazz, declaredField), fieldValue.toString()); continue; } if (queryCondition.isCondition() == false) { continue; } Method method = queryCondition.value().getMethod(); method.invoke(queryWrapper, StringTool.isNotEmpty(fieldValue.toString()), QueryTool.getTableName(baseClazz) + "." + QueryTool.getTableFieldName(baseClazz, declaredField), fieldValue.toString()); } } catch (Exception e) { throw new RuntimeException("填充預設的SQL條件出錯", e); } } /** * 填充預設排序 * * @param queryWrapper * @param pageForm */ public static void paddingDefaultOrderQuery(QueryWrapper queryWrapper, PageForm pageForm) { queryWrapper.orderBy(pageForm != null && StringTool.isNotEmpty(pageForm.getColumnName()), pageForm.getIsAsc() == null ? false : pageForm.getIsAsc(), pageForm.getColumnName()); } /** * 獲取表名稱 * * @return */ public static String getTableName(Class baseClazz) { TableName tableName = (TableName) baseClazz.getDeclaredAnnotation(TableName.class); if (tableName != null && StringTool.isNotEmpty(tableName.value())) { return tableName.value(); } return StringTool.toUnderline(baseClazz.getClass().getName()); } /** * 獲取欄位名 * * @param field * @return */ public static String getTableFieldName(Class baseClazz, Field field) { Field baseField = null; try { baseField = baseClazz.getDeclaredField(field.getName()); } catch (NoSuchFieldException e) { e.printStackTrace(); } if (baseField == null) { baseField = field; } TableId tableId = baseField.getAnnotation(TableId.class); if (tableId != null && StringTool.isNotEmpty(tableId.value())) { return tableId.value(); } TableField tableField = baseField.getAnnotation(TableField.class); if (tableField != null && StringTool.isNotEmpty(tableField.value())) { return tableField.value(); } return StringTool.toUnderline(baseField.getName()); } }
最後我們就可以使用工具類來填充了 。
public List<UserMo> list (UserForm userForm) { QueryWrapper<UserMo> queryWrapper = new QueryWrapper<>(); QueryTool.paddingDefaultConditionQuery(UserMo.class, queryWrapper, userForm); return userMapper.selectList(queryWrapper);}
可以看到這樣大大減少了需要填充的欄位。如果有特殊欄位,也能透過註解方式,跳過特殊欄位,再自行填充就好。