提高效率一直是個永恆的話題,編程中有一項也是可以提到效率的,那就是專注做一件事情,讓其它沒有強緊密聯系的與之分開。這裡分享下我們做CRUD時遇到的常見數據處理場景:
•數據庫表字段全部設計為非空,即使這個字段在業務上是可以為空的,之所以將數據庫表字段全部設計為非空,這裡有優點也有缺點,我們認為優點大於缺點,所以選擇了它
優點:
1.獲取值時,不用判斷這個字段是否為null,直接可用於邏輯運算。
2.mysql DBA推薦此方案,可能是有利於性能,這裡我並非求證過。
缺點:
1.業務含義沒有null清楚,比如int字段默認值設置成0,0就沒有null語義清晰。
2.在使用ORM插入數據時,需要處理非空字段值為null的問題。
• 系統字段的賦值,比如創建人,創建人id,創建時間,編輯人,編輯人id,編輯時間等,這些都需要在實際插入數據庫前賦值給Model。這些系統字段與具體的業務一般沒有太大的關聯關系,只是起到標注數據被什麼人在什麼時間處理的,當這些非業務相關的代碼充斥在代碼中時,就顯得有些多余,而且這類代碼多了也會顯示冗余,最後帶來的結果就是非關鍵代碼比例大。
上面關於默認值與null語義問題不需要解決,因為我們認為具有默認值帶來的優點遠大於可空字段帶來的煩惱,我們來看默認值與系統字段一般情況下如何處理:
•在操作ORM時,將模型所有可空的字段都手動賦值成默認值,int的賦值為0等。
•在設計數據庫時,將非空字段加上默認值,讓數據庫來處理這些未插入值的字段,如果使用mybatis的話,mapper中提到的插入操作有兩個:insert,insertSelective,後面這個insertSelective就是處理非空字段的,即插入的模型對於不需要賦值的字段就保持null值,數據庫在插入時生成的sql語句也不會包含這些字段,這樣就可以利用上數據庫的默認值了。如果正巧數據庫的結構當初設計時沒有設計默認值,又不能改的情況就比較糟糕了,情況回到上面手動賦值,可能會出現類似如下的代碼:編寫一個函數通過反射來解析每個字段,如果為null就修改為默認值:
public static <T> void emptyNullValue(final T model) { Class<?> tClass = model.getClass(); List<Field> fields = Arrays.asList(tClass.getDeclaredFields()); for (Field field : fields) { Type t = field.getType(); field.setAccessible(true); try { if (t == String.class && field.get(model) == null) { field.set(model, ""); } else if (t == BigDecimal.class && field.get(model) == null) { field.set(model, new BigDecimal(0)); } else if (t == Long.class && field.get(model) == null) { field.set(model, new Long(0)); } else if (t == Integer.class && field.get(model) == null) { field.set(model, new Integer(0)); } else if (t == Date.class && field.get(model) == null) { field.set(model, TimeHelper.LocalDateTimeToDate(java.time.LocalDateTime.of(1990, 1, 1, 0, 0, 0, 0))); } } catch (IllegalAccessException e) { e.printStackTrace(); } } }
然後在代碼調用insert前調用函數來解決:
ModelHelper.emptyNullValue(request);
如何處理系統字段呢,在創建編輯數據時,需要獲取當前用戶,然後根據邏輯分別更新創建人信息以及編輯人信息,我們專門編寫一個反射機制的函數來處理系統字段:
注:下面的系統字段的識別,是靠系統約定實現的,比如creator約定為創建人等,可根據不同的情況做數據兼容,如果系統設計的好,一般在一個系統下所有表的風格應該是相同的。
public static <T> void buildCreateAndModify(T model,ModifyModel modifyModel,boolean isCreate){ Class<?> tClass = model.getClass(); List<Field> fields = Arrays.asList(tClass.getDeclaredFields()); for (Field field : fields) { Type t = field.getType(); field.setAccessible(true); try { if(isCreate){ if (field.getName().equals(modifyModel.getcId())) { field.set(model, modifyModel.getUserId()); } if (field.getName().equals(modifyModel.getcName())) { field.set(model, modifyModel.getUserName()); } if (field.getName().equals(modifyModel.getcTime())) { field.set(model, new Date()); } } if (field.getName().equals(modifyModel.getmId())) { field.set(model, modifyModel.getUserId()); } if (field.getName().equals(modifyModel.getmName())) { field.set(model, modifyModel.getUserName()); } if (field.getName().equals(modifyModel.getmTime())) { field.set(model, new Date()); } } catch (IllegalAccessException e) { e.printStackTrace(); } } }
最後在數據處理前,根據創建或者編輯去調用函數來給系統字段賦值,這類代碼都混雜在業務代碼中。
ModifyModel modifyModel = new ModifyModel(); modifyModel.setUserId(getCurrentEmployee().getId()); modifyModel.setUserName(getCurrentEmployee().getName()); if (request.getId() == 0) { ModelHelper.buildCreateAndModify(request, modifyModel, true); deptService.insert(request); } else { ModelHelper.buildCreateAndModify(request, modifyModel, false); deptService.updateByPrimaryKey(request); }
我們可以利用參數注入來解決。參數注入的理念就是在spring mvc接收到前台請求的參數後,進一步對接收到的參數做處理以達到預期的效果。我們來創建
ManageModelConfigMethodArgumentResolver,它需要實現HandlerMethodArgumentResolver,這個接口看起來比較簡單,包含兩個核心方法:
• 判斷是否是需要注入的參數,一般通過判斷參數上是否有特殊的注解來實現,也可以增加一個其它的參數判斷,可根據具體的業務做調整,我這裡只以是否有特殊注釋來判定是否需要參數注入。
@Override public boolean supportsParameter(MethodParameter parameter) { return parameter.hasParameterAnnotation(ManageModelConfig.class); }
• 參數注入,它提供了一個擴展入口,讓我們有機會對接收到的參數做進一步的處理。
@Override public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception { Object manageModel =getRequestResponseBodyMethodProcessor().resolveArgument(parameter, mavContainer, webRequest, binderFactory); ServletRequest servletRequest = webRequest.getNativeRequest(ServletRequest.class); Employee currentUser = (Employee) servletRequest.getAttribute(DEFAULT_ATTRIBUTE_GET_USER_FROM_REQUEST); if (null == currentUser) { return manageModel; } ManageModelConfig parameterAnnotation = parameter.getParameterAnnotation(ManageModelConfig.class); ModelHelper.setDefaultAndSystemFieldsValue(manageModel, currentUser,parameterAnnotation.isSetDefaultFieldsValue()); return manageModel; }
這段函數有幾處核心邏輯:
•取得參數對象,因為我們處理的是ajax請求的參數,最簡單的注入方法就是得到實際參數通過反射去處理默認字段以及系統的值。ajax請求與form表單post提交的數據綁定略有不同,可參考之前文章分享的列表頁動態搜索的參數注入(列表頁的動態條件搜索)。獲取當前請求參數對象,我們可以借助如下兩個對象配合來完成:
•RequestMappingHandlerAdapter
•RequestResponseBodyMethodProcessor
private RequestMappingHandlerAdapter requestMappingHandlerAdapter=null; private RequestResponseBodyMethodProcessor requestResponseBodyMethodProcessor = null; private RequestResponseBodyMethodProcessor getRequestResponseBodyMethodProcessor() { if(null==requestMappingHandlerAdapter) { requestMappingHandlerAdapter=new RequestMappingHandlerAdapter(); } if (null==requestResponseBodyMethodProcessor) { List<HttpMessageConverter<?>> messageConverters = requestMappingHandlerAdapter.getMessageConverters(); messageConverters.add(new MappingJackson2HttpMessageConverter()); requestResponseBodyMethodProcessor = new RequestResponseBodyMethodProcessor(messageConverters); } return requestResponseBodyMethodProcessor; }
通過如下代碼就可以取到參數對象了,其實就是讓spring mvc重新解析了一遍參數。
Object manageModel =getRequestResponseBodyMethodProcessor().resolveArgument(parameter, mavContainer, webRequest, binderFactory);
•如何獲取當前用戶,我們在成功登錄系統後,將當前用戶的信息存儲在request中,然後就可以在函數中獲取當前用戶,也可以采用其它方案,比如ThreadLocal,緩存等等。
ServletRequest servletRequest = webRequest.getNativeRequest(ServletRequest.class); Employee currentUser = (Employee) servletRequest.getAttribute(DEFAULT_ATTRIBUTE_GET_USER_FROM_REQUEST);
•調用處理函數解決默認字段以及系統的賦值,可以根據配置來決定是否處理字段默認值。
ManageModelConfig parameterAnnotation = parameter.getParameterAnnotation(ManageModelConfig.class); ModelHelper.setDefaultAndSystemFieldsValue(manageModel, currentUser,parameterAnnotation.isSetDefaultFieldsValue());
最後將我們的參數注入邏輯啟動起來,這裡選擇在xml中配置:
<mvc:annotation-driven content-negotiation-manager="contentNegotiationManager"> <mvc:argument-resolvers> <bean class="cn.wanmei.party.management.common.mvc.method.annotation.ManageModelConfigMethodArgumentResolver"/> </mvc:argument-resolvers> </mvc:annotation-driven>
再看action中的調用:只需要在參數前面增加注解@ManageModelConfig,如果需要處理默認值,則將啟用默認值的選項設置成true即可,下面的實現部分完全看不到任何與業務無關的代碼。
@RequestMapping(value = "/addOrUpdateUser") @ResponseBody public Map<String, Object> addOrUpdateUser(@ManageModelConfig(isSetDefaultFieldsValue=true) EmployeeDto request) { Map<String, Object> ret = new HashMap<>(); ValidateUtil.ValidateResult result= new ValidateUtil().ValidateModel(request); boolean isCreate=request.getId() == 0; try { if (isCreate) { employeeService.insert(request); } else { employeeService.updateByPrimaryKey(request); } ret.put("data", "ok"); }catch (Exception e){ ret.put("err", e.getMessage()); } return ret; }
通過自定義實現HandlerMethodArgumentResolver,來捕獲ajax請求的參數,利用反射機制動態的將系統字段以及需要處理默認值的字段自動賦值,避免人工干預,起到了代碼精簡,邏輯干淨,問題統一處理的目的。需要注意的是這些實現都是結合當前系統設計的,比如我們認為id字段>0就代表是更新操作,為空或者等於小於0就代表是創建,系統字段也是約定名稱的等等。