如何寫好 Java 業務程式碼？這也是有很多規範的..
為什麼要寫好業務程式碼？
直接分享一段痛苦的專案維護經歷吧，看大家有沒有類似的經歷。當時，我接手了一個維護專案，剛上班就接到新增一個顯示欄位的任務。我以為這應該是一個分分鐘就能夠搞定的小需求，沒有想到這就開始了我的痛苦之旅。我梳理了關聯的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()方法更加靈活。
參考這篇文章：
https://www.javastack.cn/article/2021/maptruct-advanced-useages/
示例：
public interface CategoryConverter {
CategoryConverter INSTANCE = Mappers.getMapper(CategoryConverter.class);
@Mappings({
@Mapping(target = "ext", expression = "java(getCategoryExt(updateCategoryDto.getStyle(),updateCategoryDto.getGoodsPageSize()))")})
Category update2Category(UpdateCategoryDto updateCategoryDto);
@Mappings({
@Mapping(target = "ext", expression = "java(getCategoryExt(addCategoryDto.getStyle(),addCategoryDto.getGoodsPageSize()))")})
Category add2Category(AddCategoryDto addCategoryDto);
}
DB資料庫公共欄位填充：
例如，公共欄位，生成日期，建立人，修改時間，修改人使用外掛的形式進行封裝，在mybatis-plus中使用MetaObjectHandler，在執行sql之前完成統一欄位值的填充。
業務平臺欄位查詢過濾：
在中臺的開發中，資料採用不同平臺code的列實現不同平臺業務資料的隔離。基於mybatis外掛機制的多租戶過濾機制實現可以參考如何使用MyBatis的plugin外掛實現多租戶的資料過濾？。
在dao層的方法或者介面上加上自定義過濾條件即可，示例如下：
@Mapper
@Repository
@MultiTenancy(multiTenancyQueryValueFactory = CustomerQueryValueFactory.class)
public interface ProductDao extends BaseMapper<Product> {
}
快取的使用：
Spring開發中通常整合spring cache使用以註解的形式使用快取。整合redis並且自定義預設時間設定可以參考（Spring Cache+redis自定義快取過期時間）。
示例如下：
/**
* 使用CacheEvict註解更新指定key的快取
*/
@Override
@CacheEvict(value = {ALL_PRODUCT_KEY,ONLINE_PRODUCT_KEY}, allEntries = true)
public Boolean add(ProductAddDto dto) {
// TODO 新增商品更新cache
}
@Override
@Cacheable(value = {ALL_PRODUCT_KEY})
public List<ProductVo> findAllProductVo() {
return this.baseMapper.selectList(null);
}
@Override
@Cacheable(value = {ONLINE_PRODUCT_KEY})
public ProductVo getOnlineProductVo() {
// TODO 設定查詢條件
return this.baseMapper.selectList(query);
}
專案如何做好程式碼註釋？
列舉類的使用：
在業務中特別是狀態的值，在對外發布api的vo物件中，加上狀態列舉值的註釋，並且使用@link 註解，可以直接連線到列舉類，讓開發者一目瞭然。
示例如下：
public class ProductVo implements Serializable { /**
* 稽核狀態
* {@link ProductStatus}
*/
@ApiModelProperty("狀態")
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);
}
加分項的規範
樂觀鎖與悲觀鎖的使用
樂觀鎖(使用Spring AOP+註解基於CAS方式實現java的樂觀鎖)設定重試次數以及重試時間，在簡單的物件屬性修改使用樂觀鎖，示例如下：
@Transactional(rollbackFor = Exception.class)
@OptimisticRetry
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屬性時，需要修改商品的價格，庫存，分類，等等屬性，這時可以對關聯關係的聚合根產品進行加鎖，程式碼如下：
@Transactional
public void updateProduct(Long id,ProductUpdateDto dto){
Product existingProduct;
// 根據產品id對資料加鎖
Assert.notNull(existingProduct = lockProduct(id), "無效的產品id！");
// TODO 邏輯條件判斷
// TODO 修改商品屬性，名稱，狀態
// TODO 修改價格
// TODO 修改庫存
// TODO 修改商品規格
}
讀寫分離的使用
開發中，經常使用mybatisplus實現讀寫分離。常規的查詢操作，就走從庫查詢，查詢請求可以不加資料庫事務，例如列表查詢，示例如下：
@Override
@DS("slave_1")
public List<Product> findList(ProductQuery query) {
QueryWrapper<Product> queryWrapper = this.buildQueryWrapper(query);
return this.baseMapper.selectList(queryWrapper);
}
mybatisplus動態資料來源預設是主庫，寫操作為了保證資料一直性，需要加上事務控制。簡單的操作可以直接加上@Transactional註解，如果寫操作涉及到非必要的查詢，或者使用到訊息中介軟體，reids等第三方外掛，可以使用宣告式事務，避免查詢或者第三方查詢異常造成資料庫長事務問題。
示例，產品下線時，使用reids生成日誌code，產品相關寫操作執行完成後，傳送訊息，程式碼如下：
public void offlineProduct(OfflineProductDto dto){
// TODO 修改操作為涉及到的查詢操作
// TODO 使用redis生成業務code
// 使用宣告式事務控制產品狀態修改的相關資料庫操作
boolean status = transactionTemplate.execute(new TransactionCallback<Boolean>() {
@Nullable
@Override
public Boolean doInTransaction(TransactionStatus status) {
try {
// TODO 更改產品狀態
} catch (Exception e) {
status.setRollbackOnly();
throw e;
}
return true;
}
});
// TODO 使用訊息中介軟體傳送訊息
}
資料庫自動給容災
結合配置中心，簡單實現資料庫的自動容災。以nacous配置中心為例，如何使用Nacos實現資料庫連線的自動切換？。在springboot啟動類加上@EnableNacosDynamicDataSource配置註解，即可無侵入的實現資料庫連線的動態切換，示例如下:
推薦一個 Spring Boot 基礎教程及實戰示例：https://github.com/javastacks/spring-boot-best-practice
@EnableNacosDynamicDataSource
public class ProductApplication {
public static void main(String[] args) {
SpringApplication.run(ProductApplication.class, args);
}
}
測試用例的編寫
基於TDD的原則，結合junit和mockito實現服務功能的測試用例，為什麼要寫單元測試？基於junit如何寫單元測試？。新增或者修改物件時，需要校驗入參的有效性，並且校驗操作以後的物件的各類屬性。以新增類目的api測試用例為例，如下，新增類別，成功後，校驗新增引數以及新增成功後的屬性，以及其他預設欄位例如狀態，排序等欄位，原始碼如下：
// 新增類別的測試用例
@Test
@Transactional
@Rollback
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;
// 名稱不能為空，名稱不能重複
@NotEmpty(message = CATEGORY_NAME_IS_EMPTY, groups = {ValidateGroup.First.class})
@EffectiveValue(shouldBeNull = true, message = CATEGORY_NAME_IS_DUPLICATE, serviceBean = NameOfCategoryForAddValidator.class, groups = {ValidateGroup.Second.class})
@ApiModelProperty(value = "類目名稱", required = true)
private String name;
@ApiModelProperty(value = "類目層級")
private Integer level;
@ApiModelProperty(value = "排序")
private Integer sort;
}
//新增失敗的校驗校驗測試用例
@Test
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://blog.csdn.net/new_com/article/details/108399421
版權宣告：本文為CSDN博主「iloveoverfly」的原創文章，遵循CC 4.0 BY-SA版權協議，轉載請附上原文出處連結及本宣告。
近期熱文推薦：
1.1,000+ 道 Java面試題及答案整理(2022最新版)
4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！
覺得不錯，別忘了隨手點贊+轉發哦！