0
  • 聊天消息
  • 系統(tǒng)消息
  • 評論與回復(fù)
登錄后你可以
  • 下載海量資料
  • 學(xué)習(xí)在線課程
  • 觀看技術(shù)視頻
  • 寫文章/發(fā)帖/加入社區(qū)
會員中心
創(chuàng)作中心

完善資料讓更多小伙伴認識你,還能領(lǐng)取20積分哦,立即完善>

3天內(nèi)不再提示

還在自己實現(xiàn)責(zé)任鏈?我建議你造輪子之前先看看這個開源項目

京東云 ? 來源:jf_75140285 ? 作者:jf_75140285 ? 2024-09-20 14:38 ? 次閱讀

1. 前言

設(shè)計模式在軟件開發(fā)中被廣泛使用。通過使用設(shè)計模式,開發(fā)人員可以更加高效地開發(fā)出高質(zhì)量的軟件系統(tǒng),提高代碼的可讀性、可維護性和可擴展性。

責(zé)任鏈模式是一種常用的行為型設(shè)計模式,它將請求沿著處理鏈進行發(fā)送,直到其中一個處理者對請求進行處理為止。在責(zé)任鏈模式中,通常會有多個處理者,每個處理者都有一個處理請求的方法。當一個請求到達處理鏈的起點時,會依次傳遞給每個處理者進行處理,直到某個處理者能夠處理該請求。這樣可以保證每個請求都能被處理,并且可以根據(jù)實際情況動態(tài)地添加或刪除處理者,以滿足不同的需求。

責(zé)任鏈模式可以幫助降低系統(tǒng)的耦合度,增加系統(tǒng)的靈活性和可擴展性,其在SpringMVC、Netty等許多框架中均有實現(xiàn)。責(zé)任鏈模式常用于以下場景:處理復(fù)雜的請求邏輯,例如權(quán)限驗證、日志記錄等;避免請求發(fā)送者和接收者之間的耦合關(guān)系;動態(tài)地組織處理流程,以適應(yīng)不同的請求類型和復(fù)雜度。

我們在日常開發(fā)中如果要使用責(zé)任鏈模式,通常需要自己來實現(xiàn),但自己臨時實現(xiàn)的責(zé)任鏈既不通用,也很容易產(chǎn)生框架與業(yè)務(wù)代碼耦合不清等問題,增加Code Review 的成本。

Netty的代碼向來以優(yōu)雅著稱,早年我在閱讀Netty的源碼時,萌生出將其責(zé)任鏈的實現(xiàn)應(yīng)用到業(yè)務(wù)開發(fā)中的想法,之后花了點時間將Netty中責(zé)任鏈的實現(xiàn)代碼抽取出來,形成了本項目,也就是pie。pie的核心代碼均來自Netty,絕大部分的 API 與 Netty 是一致的。

pie 是一個可快速上手的責(zé)任鏈框架,開發(fā)者只需要專注業(yè)務(wù),開發(fā)相應(yīng)的業(yè)務(wù)Handler,即可完成業(yè)務(wù)的責(zé)任鏈落地。

一分鐘學(xué)會、三分鐘上手、五分鐘應(yīng)用,歡迎 star。

pie 源碼地址:https://github.com/feiniaojin/pie.git

pie 案例工程源碼地址:https://github.com/feiniaojin/pie-example.git

2. 快速入門

2.1 引入 maven 依賴

pie 目前已打包發(fā)布到 maven 中央倉庫,開發(fā)者可以直接通過 maven 坐標將其引入到項目中。


    com.feiniaojin.ddd.ecosystem
    pie
    1.0

目前最新的版本是 1.0

2.2 實現(xiàn)出參工廠

出參也就是執(zhí)行結(jié)果,一般的執(zhí)行過程都要求有執(zhí)行結(jié)果返回。實現(xiàn) OutboundFactory 接口,用于產(chǎn)生接口默認返回值。

例如:

public class OutFactoryImpl implements OutboundFactory {
    @Override
    public Object newInstance() {
        Result result = new Result();
        result.setCode(0);
        result.setMsg("ok");
        return result;
    }
}

2.3 實現(xiàn) handler 接口完成業(yè)務(wù)邏輯

在 pie 案例工程( https://github.com/feiniaojin/pie-example.git )的 Example1 中,為了展示 pie 的使用方法,實現(xiàn)了一個虛擬的業(yè)務(wù)邏輯:CMS類項目修改文章標題、正文,大家不要關(guān)注修改操作放到兩個 handler 中是否合理,僅作為講解案例。

三個 Handler 功能如下:

CheckParameterHandler:用于參數(shù)校驗。

ArticleModifyTitleHandler:用于修改文章的標題。

ArticleModifyContentHandler:用于修改文章的正文。

CheckParameterHandler 的代碼如下:

public class CheckParameterHandler implements ChannelHandler {

    private Logger logger = LoggerFactory.getLogger(CheckParameterHandler.class);

    @Override
    public void channelProcess(ChannelHandlerContext ctx,
                               Object in,
                               Object out) throws Exception {

        logger.info("參數(shù)校驗:開始執(zhí)行");

        if (in instanceof ArticleTitleModifyCmd) {
            ArticleTitleModifyCmd cmd = (ArticleTitleModifyCmd) in;
            String articleId = cmd.getArticleId();
            Objects.requireNonNull(articleId, "articleId不能為空");
            String title = cmd.getTitle();
            Objects.requireNonNull(title, "title不能為空");
            String content = cmd.getContent();
            Objects.requireNonNull(content, "content不能為空");
        }
        logger.info("參數(shù)校驗:校驗通過,即將進入下一個Handler");
        ctx.fireChannelProcess(in, out);
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx,
                                Throwable cause,
                                Object in,
                                Object out) throws Exception {
        logger.error("參數(shù)校驗:異常處理邏輯", cause);
        Result re = (Result) out;
        re.setCode(400);
        re.setMsg("參數(shù)異常");
    }
}

ArticleModifyTitleHandler 的代碼如下:

public class ArticleModifyTitleHandler implements ChannelHandler {

    private Logger logger = LoggerFactory.getLogger(ArticleModifyTitleHandler.class);

    @Override
    public void channelProcess(ChannelHandlerContext ctx,
                               Object in,
                               Object out) throws Exception {

        logger.info("修改標題:進入修改標題的Handler");

        ArticleTitleModifyCmd cmd = (ArticleTitleModifyCmd) in;

        String title = cmd.getTitle();
        //修改標題的業(yè)務(wù)邏輯
        logger.info("修改標題:title={}", title);

        logger.info("修改標題:執(zhí)行完成,即將進入下一個Handler");
        ctx.fireChannelProcess(in, out);
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx,
                                Throwable cause,
                                Object in,
                                Object out) throws Exception {
        logger.error("修改標題:異常處理邏輯");
        Result re = (Result) out;
        re.setCode(1501);
        re.setMsg("修改標題發(fā)生異常");
    }
}

ArticleModifyContentHandler 的代碼如下:

public class ArticleModifyContentHandler implements ChannelHandler {

    private Logger logger = LoggerFactory.getLogger(ArticleModifyContentHandler.class);

    @Override
    public void channelProcess(ChannelHandlerContext ctx,
                               Object in,
                               Object out) throws Exception {

        logger.info("修改正文:進入修改正文的Handler");
        ArticleTitleModifyCmd cmd = (ArticleTitleModifyCmd) in;
        logger.info("修改正文,content={}", cmd.getContent());
        logger.info("修改正文:執(zhí)行完成,即將進入下一個Handler");
        ctx.fireChannelProcess(in, out);
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx,
                                Throwable cause,
                                Object in,
                                Object out) throws Exception {

        logger.error("修改標題:異常處理邏輯");

        Result re = (Result) out;
        re.setCode(1502);
        re.setMsg("修改正文發(fā)生異常");
    }
}

2.4 通過 BootStrap 拼裝并執(zhí)行

public class ArticleModifyExample1 {

    private final static Logger logger = LoggerFactory.getLogger(ArticleModifyExample1.class);

    public static void main(String[] args) {
        //構(gòu)造入?yún)?        ArticleTitleModifyCmd dto = new ArticleTitleModifyCmd();
        dto.setArticleId("articleId_001");
        dto.setTitle("articleId_001_title");
        dto.setContent("articleId_001_content");

        //創(chuàng)建引導(dǎo)類
        BootStrap bootStrap = new BootStrap();

        //拼裝并執(zhí)行
        Result result = (Result) bootStrap
                .inboundParameter(dto)//入?yún)?                .outboundFactory(new ResultFactory())//出參工廠
                .channel(new ArticleModifyChannel())//自定義channel
                .addChannelHandlerAtLast("checkParameter", new CheckParameterHandler())//第一個handler
                .addChannelHandlerAtLast("modifyTitle", new ArticleModifyTitleHandler())//第二個handler
                .addChannelHandlerAtLast("modifyContent", new ArticleModifyContentHandler())//第三個handler
                .process();//執(zhí)行
        //result為執(zhí)行結(jié)果
        logger.info("result:code={},msg={}", result.getCode(), result.getMsg());
    }
}

2.5 執(zhí)行結(jié)果

以下是運行 ArticleModifyExample1 的 main 方法打出的日志,可以看到我們定義的 handler 被逐個執(zhí)行了。

wKgaombtGFuAFlFjAAMfA3tGG9c190.png

3. 異常處理

3.1 Handler 異常處理

當某個Handler執(zhí)行發(fā)生異常時,我們可將其異常處理邏輯實現(xiàn)在當前 Handler 的 exceptionCaught 方法中。

在 pie 案例工程( https://github.com/feiniaojin/pie-example.git )的 example2 包中,展示了某個 Handler 拋出異常時的處理方式。

假設(shè) ArticleModifyTitleHandler 的業(yè)務(wù)邏輯會拋出異常,實例代碼如下:

public class ArticleModifyTitleHandler implements ChannelHandler {

    private Logger logger = LoggerFactory.getLogger(ArticleModifyTitleHandler.class);

    @Override
    public void channelProcess(ChannelHandlerContext ctx,
                               Object in,
                               Object out) throws Exception {

        logger.info("修改標題:進入修改標題的Handler");
        ArticleTitleModifyCmd cmd = (ArticleTitleModifyCmd) in;
        String title = cmd.getTitle();
        //此處的異常用于模擬執(zhí)行過程中出現(xiàn)異常的場景
        throw new RuntimeException("修改title發(fā)生異常");
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx,
                                Throwable cause,
                                Object in,
                                Object out) throws Exception {
        logger.error("修改標題:異常處理邏輯");
        Result re = (Result) out;
        re.setCode(1501);
        re.setMsg("修改標題發(fā)生異常");
    }
}

此時 ArticleModifyTitleHandler 的 channelProcess 方法一定會拋出異常, 在當前 Handler 的 exceptionCaught 方法中對異常進行了處理。

運行 ArticleModifyExample2 的 main 方法,輸出如下:

wKgaombtGGeAdo9GAAHqAaCzzZs111.png

3.2 全局異常處理

有時候,我們不想每個 handler 都處理一遍異常,我們希望在執(zhí)行鏈的最后統(tǒng)一進行處理。
在 ArticleModifyExample3 中,我們展示了通過一個全局異常進行最后的異常處理,其實現(xiàn)主要分為以下幾步:

3.2.1 業(yè)務(wù) Handler 傳遞異常

如果業(yè)務(wù) Handler 實現(xiàn)了 ChannelHandler 接口,那么需要手工調(diào)用 ctx.fireExceptionCaught 方法向下傳遞異常。
例如 CheckParameterHandler 捕獲到異常時的示例如下:


@Override
public class XXXHandler implements ChannelHandler {

    //省略其他邏輯

    //異常處理
    public void exceptionCaught(ChannelHandlerContext ctx,
                                Throwable cause,
                                Object in,
                                Object out) throws Exception {

        logger.info("參數(shù)校驗的異常處理邏輯:不處理直接向后傳遞");
        ctx.fireExceptionCaught(cause, in, out);
    }
}

如果業(yè)務(wù) Handler 繼承了 ChannelHandlerAdapter,如果沒有重寫 fireExceptionCaught 方法,則默認將異常向后傳遞。

3.2.2 實現(xiàn)全局異常處理的 Handler

我們把業(yè)務(wù)異常處理邏輯放到最后的 Handler 中進行處理,該 Handler 繼承了ChannelHandlerAdapter,只需要重寫異常處理的exceptionCaught
方法。
示例代碼如下:

public class ExceptionHandler extends ChannelHandlerAdapter {

    private Logger logger = LoggerFactory.getLogger(ExceptionHandler.class);

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx,
                                Throwable cause,
                                Object in,
                                Object out) throws Exception {

        logger.error("異常處理器中的異常處理邏輯");
        Result re = (Result) out;
        re.setCode(500);
        re.setMsg("系統(tǒng)異常");
    }
}

3.2.3 將 ExceptionHandler 加入到執(zhí)行鏈中

直接通過 BootStrap 加入到執(zhí)行鏈最后即可,示例代碼如下:


public class ArticleModifyExample3 {

    private final static Logger logger = LoggerFactory.getLogger(ArticleModifyExample3.class);

    public static void main(String[] args) {
        //入?yún)?        ArticleTitleModifyCmd dto = new ArticleTitleModifyCmd();
        dto.setArticleId("articleId_001");
        dto.setTitle("articleId_001_title");
        dto.setContent("articleId_001_content");
        //創(chuàng)建引導(dǎo)類
        BootStrap bootStrap = new BootStrap();

        Result result = (Result) bootStrap
                .inboundParameter(dto)//入?yún)?                .outboundFactory(new ResultFactory())//出參工廠
                .channel(new ArticleModifyChannel())//自定義channel
                .addChannelHandlerAtLast("checkParameter", new CheckParameterHandler())//第一個handler
                .addChannelHandlerAtLast("modifyTitle", new ArticleModifyTitleHandler())//第二個handler
                .addChannelHandlerAtLast("modifyContent", new ArticleModifyContentHandler())//第三個handler
                .addChannelHandlerAtLast("exception", new ExceptionHandler())//異常處理handler
                .process();//執(zhí)行
        //result為執(zhí)行結(jié)果
        logger.info("result:code={},msg={}", result.getCode(), result.getMsg());
    }
}

3.2.4 運行 ArticleModifyExample3

運行 ArticleModifyExample3 的 main 方法,控制臺輸出如下,可以看到異常被傳遞到最后的 ExceptionHandler 中進行處理。

wKgZombtGGmAT1MbAAKoayl5eCE437.png

4. 總結(jié)

本文通過簡單的例子,向讀者介紹了如何使用pie框架快速進行責(zé)任鏈模式開發(fā),包括責(zé)任鏈初始化和異常處理等日常開發(fā)中常見的場景。讀者可以參考這些案例,并將pie框架應(yīng)用于實際開發(fā)中,以快速實現(xiàn)通用的責(zé)任鏈模式,最終降低代碼的耦合度、增加代碼的可擴展性和提高代碼的可讀性。

審核編輯 黃宇

聲明:本文內(nèi)容及配圖由入駐作者撰寫或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點僅代表作者本人,不代表電子發(fā)燒友網(wǎng)立場。文章及其配圖僅供工程師學(xué)習(xí)之用,如有內(nèi)容侵權(quán)或者其他違規(guī)問題,請聯(lián)系本站處理。 舉報投訴
  • 接口
    +關(guān)注

    關(guān)注

    33

    文章

    8352

    瀏覽量

    150508
  • 開源
    +關(guān)注

    關(guān)注

    3

    文章

    3181

    瀏覽量

    42235
  • 源碼
    +關(guān)注

    關(guān)注

    8

    文章

    629

    瀏覽量

    29074
收藏 人收藏

    評論

    相關(guān)推薦

    ElfBoard開源項目|“智慧光伏”開源項目技術(shù)文檔

    最大化地捕捉和利用。下面就和各位小伙伴詳細介紹一下這一開源項目是怎樣實現(xiàn)的。環(huán)境說明1.開發(fā)環(huán)境操作系統(tǒng):Ubuntu18.0464位版2.交叉編譯工具:arm-
    的頭像 發(fā)表于 10-11 15:52 ?258次閱讀
    ElfBoard<b class='flag-5'>開源</b><b class='flag-5'>項目</b>|“智慧光伏”<b class='flag-5'>開源</b><b class='flag-5'>項目</b>技術(shù)文檔

    Matepad pro12.2 已上市半個月,但是還沒有在開源網(wǎng)站看到該項目開源信息,違背開源精神

    Matepad pro12.2 已上市半個月,本人自己也購買了同款12+256的pad,想要同步學(xué)習(xí)下這款pad的一些體驗還不錯的功能點,但是目前為止還沒有在開源網(wǎng)站看到該項目開源
    發(fā)表于 08-27 17:25

    開源項目!基于 Arduino DIY 漂亮的宏機械鍵盤

    。 接下來,我們將要制作的這款鍵盤擁有 12 個按鍵,可以根據(jù)自己的喜好和需求,將這些按鍵與所需的快捷鍵進行關(guān)聯(lián)。盡管這個項目聽起來可能有些復(fù)雜,但實際上無論是電子部分還是軟件部分,
    發(fā)表于 08-19 17:02

    開源項目!用ESP8266 DIY會爬墻的無人機

    有點神奇,作者表示,下面介紹的這個無人機就能做到! 一個基于NodeMCU飛行控制器和安卓應(yīng)用控制的爬墻項目。完整的細節(jié)和解釋視頻。 相信,會愛上它。 玩無人機需要一個飛行控制器,
    發(fā)表于 07-04 09:22

    華為車究竟成沒成功,這個責(zé)任誰來擔(dān)?

    華為車,一種很新的車方式。
    的頭像 發(fā)表于 06-20 11:16 ?211次閱讀

    嵌入式軟件工程師如何提升自己?

    、分享項目經(jīng)驗等方式,展示自己的專業(yè)能力和行業(yè)見解,樹立自己在行業(yè)中的聲譽。 6.尋找合適的導(dǎo)師 在職業(yè)生涯的發(fā)展過程中,有一個經(jīng)驗豐富的導(dǎo)師是非常寶貴的。他們可以給予指導(dǎo)和
    發(fā)表于 06-12 11:20

    開源項目】Arduino ESP32 彩色電子氣象站

    展示是如何構(gòu)建這個項目的,以及如何使用相同或相似的顯示器來構(gòu)建自己項目。 首先,讓解釋一
    發(fā)表于 01-16 14:01

    關(guān)于FPGA的開源項目介紹

    Hello,大家好,之前給大家分享了大約一百多個關(guān)于FPGA的開源項目,涉及PCIe、網(wǎng)絡(luò)、RISC-V、視頻編碼等等,這次給大家?guī)淼氖遣豢菰锏膴蕵?b class='flag-5'>項目,主要偏向老的游戲內(nèi)核使用FP
    的頭像 發(fā)表于 01-10 10:54 ?1268次閱讀
    關(guān)于FPGA的<b class='flag-5'>開源</b><b class='flag-5'>項目</b>介紹

    開源FPGA項目有哪些

    請問開源FPGA項目有哪些?
    發(fā)表于 12-26 12:09

    OpenHarmony Meetup 2023南京站亮點搶先看

    點擊藍字 ╳ 關(guān)注我們 開源項目 OpenHarmony 是每個人的 OpenHarmony 原文標題:OpenHarmony Meetup 2023南京站亮點搶先看 文章出處:【微信公眾號:OpenAtom OpenHarmo
    的頭像 發(fā)表于 12-25 21:10 ?515次閱讀
    OpenHarmony Meetup 2023南京站亮點搶<b class='flag-5'>先看</b>

    開源項目】基于ESP32制作的小小光立方,可以使用wifi連接到電腦

    ,光立方焊接室東西太多了,有點卡。 光立方AR室,使用光立方的地板進行AR識別,這樣就可以實現(xiàn)在現(xiàn)實生活中出現(xiàn)一個虛擬的光立方在你的電腦中。這個虛擬的光立方用法跟上位機一樣 4、電腦端喇叭fft
    發(fā)表于 12-19 13:51

    還在使用傳統(tǒng)架構(gòu)的DC-DC轉(zhuǎn)換器嗎?

    還在使用傳統(tǒng)架構(gòu)的DC-DC轉(zhuǎn)換器嗎?
    的頭像 發(fā)表于 12-04 17:26 ?738次閱讀
    <b class='flag-5'>你</b><b class='flag-5'>還在</b>使用傳統(tǒng)架構(gòu)的DC-DC轉(zhuǎn)換器嗎?

    基金會旗下銅鎖/Tongsuo項目官宣密鑰管理工具RustyVault正式開源

    RustyVault正式開源。 銅鎖/Tongsuo開源項目核心成員、螞蟻集團技術(shù)專家王祖熙 銅鎖/Tongsuo是一個提供現(xiàn)代密碼學(xué)算法和安全通信協(xié)議的開源密碼學(xué)算法庫,為存儲、網(wǎng)絡(luò)
    的頭像 發(fā)表于 11-05 15:15 ?804次閱讀
    基金會旗下銅鎖/Tongsuo<b class='flag-5'>項目</b>官宣密鑰管理工具RustyVault正式<b class='flag-5'>開源</b>

    的FPGA設(shè)計加加速,NIC、Router、Switch任意實現(xiàn)

    的FPGA設(shè)計加加速,NIC、Router、Switch任意實現(xiàn) 優(yōu)秀的IC/FPGA開源項目(二)-NetFPGA 《優(yōu)秀的IC/FPGA開源
    發(fā)表于 11-01 16:27

    74hc164和74hc595驅(qū)動數(shù)碼管用哪個ic好?

    建議使用數(shù)碼管驅(qū)動芯片,比如TM1650這類的芯片,使用很簡單。 可以先看看這個芯片的資料
    發(fā)表于 10-30 08:28