實際業務中使用策略模式對代碼進行重構

一.業務描述最近在負責公司一個語音的微服務模塊優化，這個模塊主要的業務是：1.天貓精靈、小度、若琪、小京魚、小愛同學、思必馳這些第三方音響對我們的用戶進行oauth2/JWT授權； 2.這些第三方音響服務調用我們的設備發現介面對公司的設備信息在第三方平臺進行一個存儲；3.第三方平臺對用戶發出的語音 ...

一.業務描述

最近在負責公司一個語音的微服務模塊優化，這個模塊主要的業務是：1.天貓精靈、小度、若琪、小京魚、小愛同學、思必馳這些第三方音響對我們的用戶進行oauth2/JWT授權； 2.這些第三方音響服務調用我們的設備發現介面對公司的設備信息在第三方平臺進行一個存儲；3.第三方平臺對用戶發出的語音進行解析，然後識別出需要控制的設備再調用我們的設備控制介面對公司的設備進行控制；

二.需要優化的點

上述發現、控制介面分別寫了五個API，並且在Controller層有著大量的業務校驗，然後再在Controller層調用Service層的設備發現、控制方法；這些業務校驗的邏輯一模一樣；

字有點不好看，兄dei們獻醜了，嘿嘿

三.優化（為方便演示這個舉三個語音平臺的例子）

1.對不同平臺的業務實現代碼進行重構（圖中的②）

① 將之前的三個語音介面提取為同一個策略介面命名為：（VoiceStrategyService）

public interface VoiceStrategyService {

    /**
     * @description:  語音控制API
     * @param: [jsonObject]
     * @return: com.alibaba.fastjson.JSONObject
     * @author: zhouhong
     * @date: 2023/5/18 9:34
     */
    JSONObject operateApi(@RequestBody JSONObject jsonObject);
}

② 其他幾個實現類實現（VoiceStrategyService）這一個介面

其他幾個語音實現類實現上面的那個策略介面，每個策略實現類對應一個業務場景，實現具體的方法邏輯。

@Service
@Log4j2
public class AliGenieServiceImpl implements VoiceStrategyService {
    @Override
    public JSONObject operateApi(JSONObject jsonObject) {
        log.info("天貓精靈-設備發現/控製成功！");
        return null;
    }
}

@Service
@Log4j2
public class DuerOSServiceImpl implements VoiceStrategyService {
    @Override
    public JSONObject operateApi(JSONObject jsonObject) {
        log.info("小度-設備發現/控製成功！");
        return null;
    }
}

@Service
@Log4j2
public class RokidServiceImpl implements VoiceStrategyService {
    @Override
    public JSONObject operateApi(JSONObject jsonObject) {
        log.info("若琪-設備發現/控製成功！");
        return null;
    }
}

@Service
@Log4j2
public class RokidServiceImpl implements VoiceStrategyService {
    @Override
    public JSONObject operateApi(JSONObject jsonObject) {
        log.info("若琪-設備發現/控製成功！");
        return null;
    }
}

③ 接下來，定義一個上下文類（VoiceStrategyContext），該類持有一個策略對象，並提供一個方法用於設置策略對象

/**
 * @description: 語音策略上下文
 * @author: zhouhong
 * @date: 2023/5/20 14:27
 * @version: 1.0
 */
public class VoiceStrategyContext {
    @Resource
    private VoiceStrategyService voiceStrategyService;
    private void setVoiceStrategy(VoiceStrategyService voiceStrategyService) {
        this.voiceStrategyService = voiceStrategyService;
    }
    private JSONObject executeStrategy(JSONObject jsonObject) {
        if (voiceStrategyService != null) {
            return voiceStrategyService.operateApi(jsonObject);
        }
        return null;
    }
    /**
      * @description: 根據傳過來的KEY值選擇具體的策略
      * @return: com.alibaba.fastjson.JSONObject
      * @author: zhouhong
      * @date: 2023/5/20 15:03
      */
    public JSONObject executeStrategyByKey(String key, JSONObject jsonObject) {
        switch (key) {
            case "aliGenie" : {
                this.setVoiceStrategy(new AliGenieServiceImpl());
                return this.executeStrategy(jsonObject);
            }
            case "duerOS" : {
                this.setVoiceStrategy(new DuerOSServiceImpl());
                return this.executeStrategy(jsonObject);
            }
            case "rokid" : {
                this.setVoiceStrategy(new RokidServiceImpl());
                return this.executeStrategy(jsonObject);
            }
            default: {
                return null;
            }
        }
    }
}

這個如果在下一層調用時知道自己需要調用哪個策略，那麼 executeStrategyByKey() 方法可以直接忽略，具體調用如下所示：

/**
 * @description: 測試類
 * @author: zhouhong
 * @date: 2023/5/20 15:06
 * @version: 1.0
 */
public class TextMain {
    public static void main(String[] args) {
        VoiceStrategyContext voiceStrategyContext = new VoiceStrategyContext();
        JSONObject jsonObject = new JSONObject();
        // 天貓精靈
        voiceStrategyContext.setVoiceStrategy(new AliGenieServiceImpl());
        voiceStrategyContext.executeStrategy(jsonObject);
        // 小度
        voiceStrategyContext.setVoiceStrategy(new DuerOSServiceImpl());
        voiceStrategyContext.executeStrategy(jsonObject);
        // 若琪
        voiceStrategyContext.setVoiceStrategy(new RokidServiceImpl());
        voiceStrategyContext.executeStrategy(jsonObject);
    }
}

結果：

15:12:38.474 [main] INFO com.zhouhong.designpattern.strategy.service.impl.AliGenieServiceImpl - 天貓精靈-設備發現/控製成功！
15:12:38.477 [main] INFO com.zhouhong.designpattern.strategy.service.impl.DuerOSServiceImpl - 小度-設備發現/控製成功！
15:12:38.477 [main] INFO com.zhouhong.designpattern.strategy.service.impl.RokidServiceImpl - 若琪-設備發現/控製成功！

2.對開始那張圖的 ① 進行代碼提取

這個比較簡單，直接選中需要提取的代碼塊 Windows系統中按住Ctrl 和 Alt 再加 M 鍵，就可以快速的將需要提取的代碼從方法中抽離出來，然後新建一個Service層介面對其進行實現即可，主要示例代碼如下：

/**
 * @description: 語音控制公共方法抽取
 * @author: zhouhong
 * @date: 2023/5/17 10:58
 * @version: 1.0
 */
public interface VoiceCommonApiService {
    /**
     * @description:  語音控制公共方法抽取 -- RequestBody格式
     * @param: [jsonObject, platform]
     * @return: com.alibaba.fastjson.JSONObject
     * @author: zhouhong
     * @date: 2023/5/17 11:00
     */
    JSONObject voiceRequestBodyCommonApi(JSONObject jsonObject, String platform);
}

/**
 * @description: 語音公共方法抽離
 * @author: zhouhong
 * @date: 2023/5/17 11:00
 * @version: 1.0
 */
@Service
@Log4j2
public class VoiceCommonApiServiceImpl implements VoiceCommonApiService {
    @Resource
    private VoiceStrategyContext voiceStrategyContext;
    @Override
    public JSONObject voiceRequestBodyCommonApi(JSONObject jsonObject, String platform) {
        log.info("大量邏輯校驗代碼......");
        voiceStrategyContext.executeStrategyByKey(platform, jsonObject);
        log.info("其他業務代碼......");
        return null;
    }
}

優化完工

四.設計模式總結

1.簡介

策略模式是一種行為型設計模式，它允許在運行時選擇演算法的行為。該模式將不同的演算法封裝在各自獨立的策略類中，使得它們可以互相替換，而不會影響到客戶端代碼。

2.主要參與角色

環境類（Context）：環境類持有一個策略對象，併在需要執行演算法時調用策略對象的方法。它提供了一個介面供客戶端代碼設置策略對象。
抽象策略類（Strategy）：定義了策略對象的介面或抽象類。它描述了演算法的通用行為，可以包含演算法的輸入參數。
具體策略類（Concrete Strategy）：實現了策略介面或繼承了抽象策略類，並提供了具體的演算法實現

3.工作流程

客戶端代碼創建一個環境對象（Context）。
客戶端根據需求選擇一個具體策略類，並將其設置到環境對象中。
環境對象在需要執行演算法的時候，調用所持有的策略對象的方法。
策略對象根據自身的演算法實現進行處理，並返回結果給環境對象。
客戶端通過環境對象獲取演算法的結果。

4.使用場景

多種演算法選擇：當有多個演算法可供選擇，且需要在運行時動態選擇其中一種演算法時，可以使用策略模式。例如，在圖像處理中，可以根據不同的要求選擇不同的壓縮演算法。
避免條件語句：當代碼中存在大量的條件語句用於根據不同條件執行不同的行為時，可以考慮使用策略模式來替代這些條件語句。策略模式將每種行為封裝在單獨的策略類中，使代碼更加清晰、可維護。
動態配置行為：當需要動態地配置對象的行為時，可以使用策略模式。例如，在電商系統中，可以根據用戶的會員級別，動態選擇不同的折扣策略。
可擴展性：策略模式提供了一種可擴展的方式，允許添加新的策略類來滿足新的需求，而無需修改現有代碼。這種靈活性使得策略模式在需要頻繁添加新的演算法或行為的情況下非常有用。
單一職責原則：策略模式可以將不同的演算法或行為分離到各自的策略類中，遵循了單一職責原則，使得每個類只關註自己的策略實現。

5.優缺點

優點：

提供了一種清晰的方式來管理不同演算法的實現，並將其與客戶端代碼解耦。
策略類可以靈活地替換和擴展，不會對客戶端代碼造成影響。
提高了代碼的可維護性和可讀性，減少了大量的條件語句。

缺點：

增加了類的數量，每個具體策略類都需要單獨實現一個類。

五.示例代碼地址

https://github.com/Tom-shushu/work-study.git 代碼中的 design-pattern 項目

本文來自博客園，作者：Tom-shushu，轉載請註明原文鏈接：https://www.cnblogs.com/Tom-shushu/p/17417295.html