為什么要寫好業務代碼?
直接分享一段痛苦的項目維護經歷吧,看大家有沒有類似的經歷。當時,我接手了一個維護項目,剛上班就接到新增一個顯示字段的任務。我以為這應該是一個分分鐘就能夠搞定的小需求,沒有想到這就開始了我的痛苦之旅。我梳理了關聯的api后,發現每個api都是從controller控制層-》service-》服務層-dao數據層,甚至每個api都對應一個sql查詢。
但是,所有的api之間又有很大類似的代碼。我開始閱讀代碼的時候,發現一個特殊的controller,在該controller里包括身份校驗,參數校驗,各種業務代碼,各種if else,for循環語句,甚至dao層的邏輯都融到了一塊。
更讓人悲痛欲絕的是項目沒有文檔,代碼也幾乎沒注釋,沒有測試用例,我還是直接擼代碼梳理業務,很多屬性字段無法理解到底代表什么,例如,ajAmount,gjjAmount;在sql語句中寫status in(1,2,4,6),case when,等很多魔法數條件判斷。
我最后直接抓包調用了一下api,然后,通過與頁面的展示端字段匹配我才知道ajAmount,gjjAmount分別表示按揭貸款,公積金代碼,status的部分字段是什么意思。這樣的項目維護經歷,你有沒有類似的經歷?
個人認為,只要我們做到api拒絕煙囪式開發,業務代碼拒絕All in one,項目做好代碼注釋,就可以寫出易閱讀,好擴展的代碼。
API如何拒絕煙囪式開發
上述的api開發開發過程就是典型的煙囪式開發模式,所有的api服務與相似業務,但是每個api都是完全獨立的開發,其開發流程如圖:
如上的開發流程有幾個弊端,如下:
業務代碼重復,在不同的service實現中,業務相似的話會有大量重復代碼。
數據庫表結構的改動需要修改所有涉及到的dao層,維護成本比較高。
此類相似業務,api層定義各自顯示對象,dao層負責獲取全量數據(例如,用戶查詢,就獲取整個用戶表字段的數據),service層定義業務對象,根據不同api不同業務類型的判斷,根據dao查詢的數據組轉業務對象,以及業務對象向api顯示對象的轉換。
開發流程如圖:
這樣的開發模式有如下優勢:
業務代碼集中在service層,專注業務對象bo的封裝,以及業務對象向給類顯示層vo的轉換;封裝復用邏輯,可以大量減少重復代碼。如果,設計模式從一開始就設計得易擴展,后期維護就快捷的多。
數據庫的改動只涉及到db層,能夠快速的在各個業務響應。
業務代碼如何拒絕All in one
以上的controller代碼最突出的缺點就是代碼完全無法復用,完全沒有使用到面向對象封裝,集成,多態的特性。業務開發中,一般都是權限校驗,參數校驗,業務判斷,業務對象轉換數據庫操作。
我的做法是業務抽象,把公共代碼進行抽取,通過配置的形式的方式調用,使業務代碼可以以可插拔的方式選擇指定的權限校驗,參數校驗。簡單來說,就是善用AOP面向切面編程的思想,示例如下:
權限校驗:
使用aop對權限校驗邏輯進行抽取,能夠通過注解的方式指定哪些controller需要進行權限校驗。對用戶進行數據過濾時,使用controller的攔截器獲取該用戶擁有的各類權限,并把用戶數據保存在上下文threadloal中,并且通過配置對指定url進行攔截。在業務層,從上下文拿到用戶權限數據做各類數據業務過濾,通過aop實現各類攔截業務的指定調用。
參數校驗:
使用java validtion對通用的字段,例如電話號碼,身份證,進行擴展,詳細可以參考,如何使用validation校驗參數?,在項目中其他類似校驗進行復用。
業務判斷:使用設計模式對不同類型的業務開發進行封裝,集成,多態擴展;這樣在后期的擴展中可以基于開發封閉原則,針對新的業務擴展子類即可。
業務對象轉換數:
業務開發過程中,依照阿里巴巴研發規范的要求,存在DO(數據庫表結構一致的對象),BO(業務對象),DTO(數據傳輸對象),VO(顯示層對象),Query(查詢對象)。
使用MapStruct,可以靈活的控制的不同屬性值之間的轉換規格,比org.springframework.beans.BeanUtils.copyProperties()方法更加靈活。
示例: public interface CategoryConverter { CategoryConverter INSTANCE = Mappers.getMapper(CategoryConverter.class); ({ (target = "ext", expression = "java(getCategoryExt(updateCategoryDto.getStyle(),updateCategoryDto.getGoodsPageSize()))")}) Category update2Category(UpdateCategoryDto updateCategoryDto); ({ (target = "ext", expression = "java(getCategoryExt(addCategoryDto.getStyle(),addCategoryDto.getGoodsPageSize()))")}) Category add2Category(AddCategoryDto addCategoryDto); }
DB數據庫公共字段填充:
例如,公共字段,生成日期,創建人,修改時間,修改人使用插件的形式進行封裝,在mybatis-plus中使用MetaObjectHandler,在執行sql之前完成統一字段值的填充。
業務平臺字段查詢過濾:
在中臺的開發中,數據采用不同平臺code的列實現不同平臺業務數據的隔離?;趍ybatis插件機制的多租戶過濾機制實現可以參考如何使用MyBatis的plugin插件實現多租戶的數據過濾?。
在dao層的方法或者接口上加上自定義過濾條件即可,示例如下:
multiTenancyQueryValueFactory = CustomerQueryValueFactory.class) public interface ProductDao extends BaseMapper<Product> { }(
緩存的使用:
Spring開發中通常集成spring cache使用以注解的形式使用緩存。整合redis并且自定義默認時間設置可以參考(Spring Cache+redis自定義緩存過期時間)。
示例如下:
/** * 使用CacheEvict注解更新指定key的緩存 */ (value = {ALL_PRODUCT_KEY,ONLINE_PRODUCT_KEY}, allEntries = true) public Boolean add(ProductAddDto dto) { // TODO 添加商品更新cache } (value = {ALL_PRODUCT_KEY}) public List<ProductVo> findAllProductVo() { return this.baseMapper.selectList(null); } (value = {ONLINE_PRODUCT_KEY}) public ProductVo getOnlineProductVo() { // TODO 設置查詢條件 return this.baseMapper.selectList(query); }
項目如何做好代碼注釋?
枚舉類的使用:
在業務中特別是狀態的值,在對外發布api的vo對象中,加上狀態枚舉值的注釋,并且使用@link 注解,可以直接連接到枚舉類,讓開發者一目了然。
示例如下:
public class ProductVo implements Serializable { /** * 審核狀態 * {@link ProductStatus} */ ("狀態") private Integer status; }
遷移sql查詢條件:
避免在sql層寫固定的通用的過濾條件,遷移到服務層做處理。
示例如下:
// sql查詢條件 SELECT * from product where status != -1 and shop_status != 6 // 在業務層把各類狀態值進行條件設置 public PageData<ProductVo> findCustPage(Query query ){ // 產品上線,顯示狀態 query.setStatus(ProductStatus.ONSHELF); // 產品顯示狀態 query.setHideState(HideState.VISIBAL); // 店鋪未下線 query.setNotStatus(ShopStatus.OFFLINE); return productService.findProductVoPage(query); }
加分項的規范
樂觀鎖與悲觀鎖的使用
阿里的《Java開發手冊》建議看下。樂觀鎖(使用Spring AOP+注解基于CAS方式實現java的樂觀鎖)設置重試次數以及重試時間,在簡單的對象屬性修改使用樂觀鎖,示例如下:
rollbackFor = Exception.class) public void updateGoods(GoodsUpdateDto dto) { Goods existGoods = this.getGoods(dto.getCode()); // 屬性邏輯判斷 // if (0 == goodsDao.updateGoods(existGoods, dto)) { throw new OptimisticLockingFailureException("update goods optimistic locking failure!"); } }(
悲觀鎖在業務場景比較復雜,關聯關系比較多的情況下使用。例如修改SKU屬性時,需要修改商品的價格,庫存,分類,等等屬性,這時可以對關聯關系的聚合根產品進行加鎖,代碼如下:
public void updateProduct(Long id,ProductUpdateDto dto){ Product existingProduct; // 根據產品id對數據加鎖 Assert.notNull(existingProduct = lockProduct(id), "無效的產品id!"); // TODO 邏輯條件判斷 // TODO 修改商品屬性,名稱,狀態 // TODO 修改價格 // TODO 修改庫存 // TODO 修改商品規格 }
讀寫分離的使用
開發中,經常使用mybatisplus實現讀寫分離。常規的查詢操作,就走從庫查詢,查詢請求可以不加數據庫事務,例如列表查詢,示例如下:
mybatisplus動態數據源默認是主庫,寫操作為了保證數據一直性,需要加上事務控制。簡單的操作可以直接加上@Transactional注解,如果寫操作涉及到非必要的查詢,或者使用到消息中間件,reids等第三方插件,可以使用聲明式事務,避免查詢或者第三方查詢異常造成數據庫長事務問題。
"slave_1") public List<Product> findList(ProductQuery query) { QueryWrapper<Product> queryWrapper = this.buildQueryWrapper(query); return this.baseMapper.selectList(queryWrapper); }(
示例,產品下線時,使用reids生成日志code,產品相關寫操作執行完成后,發送消息,代碼如下:
public void offlineProduct(OfflineProductDto dto){ // TODO 修改操作為涉及到的查詢操作 // TODO 使用redis生成業務code // 使用聲明式事務控制產品狀態修改的相關數據庫操作 boolean status = transactionTemplate.execute(new TransactionCallback<Boolean>() { public Boolean doInTransaction(TransactionStatus status) { try { // TODO 更改產品狀態 } catch (Exception e) { status.setRollbackOnly(); throw e; } return true; } }); // TODO 使用消息中間件發送消息 }
數據庫自動給容災
結合配置中心,簡單實現數據庫的自動容災。以nacous配置中心為例,如何使用Nacos實現數據庫連接的自動切換?。
在springboot啟動類加上@EnableNacosDynamicDataSource配置注解,即可無侵入的實現數據庫連接的動態切換,示例如下:
public class ProductApplication { public static void main(String[] args) { SpringApplication.run(ProductApplication.class, args); } }
測試用例的編寫
基于TDD的原則,結合junit和mockito實現服務功能的測試用例,為什么要寫單元測試?基于junit如何寫單元測試?。添加或者修改對象時,需要校驗入參的有效性,并且校驗操作以后的對象的各類屬性。
以添加類目的api測試用例為例,如下,添加類別,成功后,校驗添加參數以及添加成功后的屬性,以及其他默認字段例如狀態,排序等字段,源碼如下:
// 添加類別的測試用例 public void success2addCategory() throws Exception { AddCategoryDto addCategoryDto = new AddCategoryDto(); addCategoryDto.setName("服裝"); addCategoryDto.setLevel(1); addCategoryDto.setSort(1); Response<CategorySuccessVo> responseCategorySuccessVo = this.addCategory(addCategoryDto); CategorySuccessVo addParentCategorySuccessVo = responseCategorySuccessVo.getData(); org.junit.Assert.assertNotNull(addParentCategorySuccessVo); org.junit.Assert.assertNotNull(addParentCategorySuccessVo.getId()); org.junit.Assert.assertEquals(addParentCategorySuccessVo.getPid(), ROOT_PID); org.junit.Assert.assertEquals(addParentCategorySuccessVo.getStatus(), CategoryEnum.CATEGORY_STATUS_DOWN.getValue()); org.junit.Assert.assertEquals(addParentCategorySuccessVo.getName(), addCategoryDto.getName()); org.junit.Assert.assertEquals(addParentCategorySuccessVo.getLevel(), addCategoryDto.getLevel()); org.junit.Assert.assertEquals(addParentCategorySuccessVo.getSort(), addCategoryDto.getSort()); } // 新增類目,成功添加后,返回根據id查詢CategorySuccessVo public CategorySuccessVo add(AddCategoryDto addCategoryDto, UserContext userContext) { Category addingCategory = CategoryConverter.INSTANCE.add2Category(addCategoryDto); addingCategory.setStatus(CategoryEnum.CATEGORY_STATUS_DOWN.getValue()); if (Objects.isNull(addCategoryDto.getLevel())) { addingCategory.setLevel(1); } if (Objects.isNull(addCategoryDto.getSort())) { addingCategory.setSort(100); } categoryDao.insert(addingCategory); return getCategorySuccessVo(addingCategory.getId()); } 也需要對添加類目的參數進行校驗,例如,名稱不能重復的校驗,示例如下: // 添加類目的入參 public class AddCategoryDto implements Serializable { private static final long serialVersionUID = -4752897765723264858L; // 名稱不能為空,名稱不能重復 (message = CATEGORY_NAME_IS_EMPTY, groups = {ValidateGroup.First.class}) (shouldBeNull = true, message = CATEGORY_NAME_IS_DUPLICATE, serviceBean = NameOfCategoryForAddValidator.class, groups = {ValidateGroup.Second.class}) (value = "類目名稱", required = true) private String name; (value = "類目層級") private Integer level; (value = "排序") private Integer sort; } //添加失敗的校驗校驗測試用例 public void fail2addCategory() throws Exception { AddCategoryDto addCategoryDto = new AddCategoryDto(); addCategoryDto.setName("服裝"); addCategoryDto.setLevel(1); addCategoryDto.setSort(1); // 名稱為空 addCategoryDto.setName(null); Response<CategorySuccessVo> errorResponse = this.addCategory(addCategoryDto); org.junit.Assert.assertNotNull(errorResponse); org.junit.Assert.assertNotNull(errorResponse.getMsg(), CATEGORY_NAME_IS_EMPTY); addCategoryDto.setName("服裝"); // 成功添加類目 this.addCategory(addCategoryDto); // 名稱重復 errorResponse = this.addCategory(addCategoryDto); org.junit.Assert.assertNotNull(errorResponse); org.junit.Assert.assertNotNull(errorResponse.getMsg(), CATEGORY_NAME_IS_DUPLICATE); }
原文地址:https://mp.weixin.qq.com/s/ZB1zkGCX28EZ21RFcRYR6Q