“六神”——技术提高开发效率的一个方案
這個方案并不是我在系統設計方面的最早一次嘗試。但它在提高開發效率方面,是效果最為顯著的一個方案。
簡介
“六神”框架提供了一套簡單而通用的、從Web層到數據庫操作(增加單個數據、刪除單個數據、修改單個數據、查詢單個數據、查分頁列表、查不分頁列表,六個操作,因此名為“六神”)的基礎組件。并且,它為復雜的數據庫操作留下了擴展點。
在當時的技術背景下,這套框架使用Struts2.0+Spring+myBatis來實現。但是它的設計思路是可以適用于其它技術的。
在應用了這套框架之后,我們那個系統在一個月時間上線14個功能模塊,效率提升了近三倍。
背景
當時我們接下的項目是一個近似于OA系統的稽核系統。這個系統的主要功能有兩類:一是各種數據、信息的增刪改查;一是各種審批流程。審批流程的設計按下不表,“六神”就是為增刪改查功能而開發的。
思路
在完成了幾個增刪改查的頁面功能之后,我發現它們非常相似。
功能上,它們都是打開頁面時查詢一個分頁列表;然后新建一條數據;按id查詢出一條數據,并展示在彈出窗口上;彈出窗口上可以修改某些字段的值;某些頁面上還需要提供刪除數據的功能;部分配置數據、基礎數據需要提供查詢不分頁列表的功能。
流程上,則幾乎都是頁面提交一個http請求,Struts 2.0的action從中解析出參數;service層調用對應的mapper;myBatis生成并執行SQL,將操作結果返回給service;service直接將參數交還action;action將返回值轉為json字符串寫入http響應中。
而它們之間的差異性,基本是入參和出參的封裝類型、以及數據庫操作的SQL上。
流程圖
上述六個操作,都可以用下面這張流程圖來描述。而不同的操作、不同的業務需求之間,基本上只有object以及SQL有所不同。
類圖
“六神”的主要類圖中,以接口定義居多。其中的BasicDbAction和BasicDbMapper,是當時Struts2.0和MyBatis框架中的兩個實現類。
Service層上分出來了六個接口。這是為了保持接口的隔離性。但是默認類實現了全部接口,只是所有方法都直接拋出異常。實際上就只是提供了一個Adapter而已。
Dao層同樣有六個接口,但不提供默認實現。需要使用時針對myBatis或者Hibernate,分別寫自己的實現類。
原先的類結構上,Controller層只有一個Struts 2.0的action;Dao層只有一個myBatis的Mapper。兩個接口都是后來提取出來,計劃擴展到SpringMVC和Hibernate的。
Strust2.0一般會為每個HttpRequest創建一個action實例,并將HttpRequest中的參數根據action的setters/getters方法封裝到action中。這就需要action在實例化的時候,同時生成一個參數容器、即類圖中param: I的一個實例。然而,根據泛型參數無法直接做實例化。因此,需要為action配置一個參數claz并在Spring IoC中將它注入為I的具體類型。這樣才能保證action初始化的同時實例化參數param,并成功讀取到HttpRequest中的請求。
MyBatis一般會使用Mapper的類名+執行方法名作為需要執行的SQL-id,并據此id從xml文件中找到、生成實際的SQL。但是,如果直接注入、使用框架提供的MyBatis默認實現類,那么每一個查詢請求都會按照“xxx.BasicDbMapper.select”這個id去查找SQL,因而也無法找到正確的SQL。為了避免這個問題,Basid
DbMapper中使用了入參param的類名+執行方法名作為SQL-id。這樣,對“xx.ParamA”的查詢請求就會使用“xx.ParamA.select”這個id了。
另外,除了Controller之外,計劃擴展到Jms Listener。不過異步消息只有增刪改三個操作,就算“半神”吧。
代碼
https://github.com/winters1224/blogs/tree/master/code/src/main/java/net/loyintean/blog/sixgod
小結
這個小框架功能非常簡單,設計上也非常簡單。因為它太簡單,少有開發團隊愿意在這上面耗費資源。但是,這個框架能夠把簡單、重復的工作抽取出來,讓團隊把資源投放在更加復雜的工作中去。
另一方面,隨著REST、微服務等概念的深入,我認為,每個系統中的每項資源都應該提供CURD的基本API。這個小框架,能夠方便快捷的提供對應的Web API,也能為微服務的快速落地提供方便。
本文轉自 斯然在天邊 51CTO博客,原文鏈接:http://blog.51cto.com/winters1224/1909839,如需轉載請自行聯系原作者
總結
以上是生活随笔為你收集整理的“六神”——技术提高开发效率的一个方案的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 第130天:移动端-rem布局
- 下一篇: ES6/7 异步编程学习笔记