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

来源:https://www.cnblogs.com/Tom-shushu/archive/2023/05/20/17417295.html
-Advertisement-
Play Games

一.業務描述 最近在負責公司一個語音的微服務模塊優化,這個模塊主要的業務是: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.主要參與角色

  1. 環境類(Context):環境類持有一個策略對象,併在需要執行演算法時調用策略對象的方法。它提供了一個介面供客戶端代碼設置策略對象。

  2. 抽象策略類(Strategy):定義了策略對象的介面或抽象類。它描述了演算法的通用行為,可以包含演算法的輸入參數。

  3. 具體策略類(Concrete Strategy):實現了策略介面或繼承了抽象策略類,並提供了具體的演算法實現

3.工作流程

  1. 客戶端代碼創建一個環境對象(Context)。

  2. 客戶端根據需求選擇一個具體策略類,並將其設置到環境對象中。

  3. 環境對象在需要執行演算法的時候,調用所持有的策略對象的方法。

  4. 策略對象根據自身的演算法實現進行處理,並返回結果給環境對象。

  5. 客戶端通過環境對象獲取演算法的結果。

4.使用場景

  1. 多種演算法選擇:當有多個演算法可供選擇,且需要在運行時動態選擇其中一種演算法時,可以使用策略模式。例如,在圖像處理中,可以根據不同的要求選擇不同的壓縮演算法。

  2. 避免條件語句:當代碼中存在大量的條件語句用於根據不同條件執行不同的行為時,可以考慮使用策略模式來替代這些條件語句。策略模式將每種行為封裝在單獨的策略類中,使代碼更加清晰、可維護。

  3. 動態配置行為:當需要動態地配置對象的行為時,可以使用策略模式。例如,在電商系統中,可以根據用戶的會員級別,動態選擇不同的折扣策略。

  4. 可擴展性:策略模式提供了一種可擴展的方式,允許添加新的策略類來滿足新的需求,而無需修改現有代碼。這種靈活性使得策略模式在需要頻繁添加新的演算法或行為的情況下非常有用。

  5. 單一職責原則:策略模式可以將不同的演算法或行為分離到各自的策略類中,遵循了單一職責原則,使得每個類只關註自己的策略實現。

5.優缺點

優點:

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

缺點:

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

五.示例代碼地址

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

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


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 一切皆實體 目前十分流行ECS設計,主要是守望先鋒的成功,引爆了這種技術。守望先鋒採用了狀態幀這種網路技術,客戶端會進行預測,預測不准需要進行回滾,由於組件式的設計,回滾可以只回滾某些組件即可。ECS最重要的設計是邏輯跟數據的完全分離。即EC是純數據,System實際上就是邏輯,由數據驅動邏輯。數據 ...
  • 目錄 一、DNS概念 二、功能變數名稱格式類型 三、查詢類型 四、解析類型 五、配置DNS 六、dns解析實驗 1.配置正向解析 2.反向解析 3.主從解析 一、DNS概念 概念:功能變數名稱和IP地址的相互映射的分散式資料庫,可以更好的訪問互聯網。 電腦只能訪問IP地址,但是IP地址不是方便記住,採用功能變數名稱解析出 ...
  • 一、環境準備 1、虛擬機:ubuntu18.04 64位 2、交叉編譯工具包:gcc-linaro-7.5.0-2019.12-i686_arm-linux-gnueabihf.tar 下載鏈接:https://releases.linaro.org/components/toolchain/bin ...
  • > 本文首發於公眾號:Hunter後端 > 原文鏈接:[es筆記三之term,match,match_phrase 等查詢方法介紹](https://mp.weixin.qq.com/s/3tzD8dEr592WNJFH_1bKRw) 首先介紹一下在 es 里有兩種存儲字元串的欄位類型,一個是 ke ...
  • From Java To Kotlin, 空安全、擴展、函數、Lambda 概述(Summarize) * • Kotlin 是什麼? * • 可以做什麼? * • Android 官方開發語言從Java變為Kotlin,Java 有哪些問題? * • Kotlin的優點 * • Kotlin 特性 ...
  • 一、XSS攻擊 全稱跨站腳本攻擊,簡稱XSS攻擊,攻擊者通過在目標網站上HTML註入篡改網頁來插入惡意腳本, 當用戶在瀏覽網頁時獲取用戶的cookie等敏感信息,進一步做一些其他危害的操作。 根據攻擊的來源,該攻擊還可以分為: 1)存儲型攻擊:一般是在有評論功能的網站將惡意代碼當作評論內容存儲到服務 ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 一、導出靜態數據 1、安裝 vue-json-excel npm i vue-json-excel 註意,此插件對node有版本要求,安裝失敗檢查一下報錯是否由於node版本造成! 2、引入並註冊組件(以全局為例) import Vue ...
  • **本文為千鋒資深前端教學老師帶來的【JavaScript全解析】系列,文章內含豐富的代碼案例及配圖,從0到1講解JavaScript相關知識點,致力於教會每一個人學會JS!** **文末有本文重點總結,可以收藏慢慢看\~ 更多技術類內容,主頁關註一波!** # ES6函數中參數的預設值 給函數的形 ...
一周排行
    -Advertisement-
    Play Games
  • 下麵是一個標準的IDistributedCache用例: public class SomeService(IDistributedCache cache) { public async Task<SomeInformation> GetSomeInformationAsync (string na ...
  • 這個庫提供了在啟動期間實例化已註冊的單例,而不是在首次使用它時實例化。 單例通常在首次使用時創建,這可能會導致響應傳入請求的延遲高於平時。在註冊時創建實例有助於防止第一次Request請求的SLA 以往我們要在註冊的時候實例單例可能會這樣寫: //註冊: services.AddSingleton< ...
  • 最近公司的很多項目都要改單點登錄了,不過大部分都還沒敲定,目前立刻要做的就只有一個比較老的項目 先改一個試試手,主要目標就是最短最快實現功能 首先因為要保留原登錄方式,所以頁面上的改動就是在原來登錄頁面下加一個SSO登錄入口 用超鏈接寫的入口,頁面改造後如下圖: 其中超鏈接的 href="Staff ...
  • Like運算符很好用,特別是它所提供的其中*、?這兩種通配符,在Windows文件系統和各類項目中運用非常廣泛。 但Like運算符僅在VB中支持,在C#中,如何實現呢? 以下是關於LikeString的四種實現方式,其中第四種為Regex正則表達式實現,且在.NET Standard 2.0及以上平... ...
  • 一:背景 1. 講故事 前些天有位朋友找到我,說他們的程式記憶體會偶發性暴漲,自己分析了下是非托管記憶體問題,讓我幫忙看下怎麼回事?哈哈,看到這個dump我還是非常有興趣的,居然還有這種游戲幣自助機類型的程式,下次去大玩家看看他們出幣的機器後端是不是C#寫的?由於dump是linux上的程式,剛好win ...
  • 前言 大家好,我是老馬。很高興遇到你。 我們為 java 開發者實現了 java 版本的 nginx https://github.com/houbb/nginx4j 如果你想知道 servlet 如何處理的,可以參考我的另一個項目: 手寫從零實現簡易版 tomcat minicat 手寫 ngin ...
  • 上一次的介紹,主要圍繞如何統一去捕獲異常,以及為每一種異常添加自己的Mapper實現,並且我們知道,當在ExceptionMapper中返回非200的Response,不支持application/json的響應類型,而是寫死的text/plain類型。 Filter為二方包異常手動捕獲 參考:ht ...
  • 大家好,我是R哥。 今天分享一個爽飛了的面試輔導 case: 這個杭州兄弟空窗期 1 個月+,面試了 6 家公司 0 Offer,不知道問題出在哪,難道是杭州的 IT 崩盤了麽? 報名面試輔導後,經過一個多月的輔導打磨,現在成功入職某上市公司,漲薪 30%+,955 工作制,不咋加班,還不捲。 其他 ...
  • 引入依賴 <!--Freemarker wls--> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.30</version> </dependency> ...
  • 你應如何運行程式 互動式命令模式 開始一個互動式會話 一般是在操作系統命令行下輸入python,且不帶任何參數 系統路徑 如果沒有設置系統的PATH環境變數來包括Python的安裝路徑,可能需要機器上Python可執行文件的完整路徑來代替python 運行的位置:代碼位置 不要輸入的內容:提示符和註 ...