MS Enterprise Library 6.0 (五) - 再談AOP, 如何實作?

作者： -

這系列的上一篇居然是2013年…沒說錯，是2013，四年前!!!

MS Enterprise Library 6.0(一) - Unity Application Block
MS Enterprise Library 6.0 (二) - Logging Application Block
MS Enterprise Library 6.0 (三) - Exception Handling Application Block
MS Enterprise Library 6.0 (四) - Policy Injection Application Block

說真的，如果不是因為開了課，我根本早忘記我曾經寫過上面這幾篇文章。

上週六，是『團隊開發 與 架構設計 實務 』這個課程的第二天上課，在課程中我們談到了一個框架設計上我常用的技巧，也就是如何透過Attribute來實作AOP(嚴格說起來是廣義的AOP)。如果你不確定明白AOP(Aspect-Oriented Programming)的基本概念，可以參考四年前的這篇。(天啊，四年前…)

課程中，我做了一個範例(具體內容後面說)，和某位學員討論的時候，突然看到學員的螢幕上出現了一篇看似有點眼熟的文章，語氣跟我好像…咦? 作者怎麼是我？是了，就是剛才說的四年前寫的那篇，這篇文章中介紹了PIAB(policy injection application block)，這是當年我在Tech Days介紹MS Enterprise Library時，特別喜愛的一個application block，它很精采的把Business Logic和Infrastructure Logic做一個非常有效的切割，達成cross-cutting concerns的獨立性。

這一系列的文章或許是因為點擊率不很高，也或者是當時有別的事情再忙…我寫著寫著居然就忘了…也因此這個系列就沒了下文。時過境遷，這次上課的時候，我也不再介紹PIAB，因為這個PIAB Library的nuget套件很不爭氣的始終停留在2013年都沒更新，因此我們只能從底層架構說明透過Attribute實現AOP概念的作法。

不過這樣也好，學員可以從根本理解實現AOP可能的幾個方式 。然而，美中不足的是這樣去實現AOP的Method呼叫時，就得要有另一個Loader/Lancher來做attribute行為上的判斷。

『這樣呼叫Method時似乎有些不直覺？有沒有更好的做法？』學員問。

『其實你可以自己仿Unity Container做一個Proxy的機制…』因為在課堂上我們還有一併介紹到Unity，因此我這麼回答。

然而因為時間的關係，我也就無法在課堂上直接做一個Demo，想想頗為遺憾，因此課程結束後的這幾天，我抽了點時間把這個心裡想要實現的小套件，仿造PIAB的方式來製作一下。

需求與命題

首先來整理一下這個命題，我們知道AOP想把Business Logic和Infrastructure Logic做一個切割，達成cross-cutting concerns的獨立性，具體情境是什麼呢？看底下這一段code:

上面這段程式碼的第10行使用了Calculate()這個Method來計算BMI，但這段Code有些小問題，例如，傳入身高體重是0時候，可能發生Exception。

你可能會想，這不要緊，我們在Method中加入try…catch，類似底下這樣(當然我知道可以加上傳入參數的檢查，但我想講的點是try…catch啦，所以我們先這樣幹):

這樣做沒問題，但如此一來，我們就讓計算BMI這段code，嚴重的與處理exception中的發mail或發Line訊息的功能相依!

此外，倘若我們想針對該Method被呼叫幾次，做一個Log，你可能也會在Calculate()這個Method中加入讀寫檔案存取log或db的code，這下不得了，簡單的BMI計算(business logic)開始與檔案系統、DB、發mail…etc(Infrastructure  logic)相依，萬一你程式碼中不只一個地方需要進行Log，而是有好幾個method都需要log，那就更精采了…

而AOP希望實現的，就是讓這些Business Logic(BMI計算)和Infrastructure Logic(Log, 錯誤處理, …etc.)之間可以不要彼此過分相依…

如何實現呢？可以透過Attribute。

想像一下，倘若我們可以這樣做:

倘若我們可以透過對Method掛上我們寫好的Attribute，就賦予Calculate()這個Method特殊的功能，例如一旦發生exception，就自動發Line訊息通知Admin，如果該Method被呼叫，就自動在Log file中記錄…。倘若這一切只需要掛上Attribute就能實現，我們就毋須破壞原本計算BMI的Calculate()這個method中的程式碼了…

但，真的可以這樣嗎？當然可以…

請在專案中透過nuget加入一個套件 isRock.Framework.AOP，完成後，請先引用using isRock.Framework.AOP:

接著設計一個Logging Attribute(請注意繼承自PolicyInjectionAttributeBase):

我們在上面這個自行設計的Attribute當中，透過SaveLog這個方法來儲存Log。並且override了AfterInvoke()來呼叫SaveLog()。

完成後再將原本計算 BMI的Class修改如下(請注意只改了1, 13行)：

最後，再調整一下Main中的程式碼(只改了第5行)。

神奇的事情發生了。

你會發現，我們的主程式，上面的main()中其實只改了小小一行(第五行)，就讓我們自己寫的Logging attribute作用到Calculate()的身上了。由於Logging attribute中的第6行override了AfterInvoke()這個method，該Method會自動在Calculate()方法被呼叫後自動被執行，其中的SaveLog()程式碼是開檔寫Log…

如此一來，每當Calculate()方法被呼叫，log.txt檔案就會被開啟並被加入一列，變成：

這樣就實現了我們一開始的需求，當某一個Method被掛上Attribute之後，就能夠增加原本沒有的功能。且將Business Logic和Infrastructure Logic做一個切割，達成cross-cutting concerns的獨立性。

我們回憶一下我們做了什麼？

  1. 首先我們引入了Nuget套件 isRock.Framework
  2. Using了isRock.Framework.AOP
  3. 接著設計了一個自己的Logging Attribute(繼承自PolicyInjectionAttributeBase)
  4. 在上述Logging Attribute當中，override了AfterInvoke()方法，該方法會在目標Method(被掛上attribute的Method)被叫用之後自動被呼叫
  5. 在上述AfterInvoke()方法中呼叫SaveLog()開檔並加上『目標Method被呼叫』的Log
  6. 為了讓attribute生效，我們修改原始的BMIProcessor類別，在Calculate（）方法上掛上LoggingAttribute:
    [Logging(LogFileName ="log.txt")]
  7. 並且讓BMIProcessor類別繼承自PolicyInjectionComponentBase
  8. 調整主程式為
    BMIProcessor BMI = PolicyInjection.Create<BMIProcessor>();

就這樣，我們透過這個框架，可以讓開發人員輕鬆的設計自己的Attribute，並且將attribute掛在Method上，實現Business Logic和Infrastructure Logic分離的AOP情境。

骨子裡，他還是使用PIAB的作法，透過reflection與Proxy的手法，完成以attribute實現類似AOP的功能:

如果你深入看，會發現我們的PolicyInjectionAttributeBase已經實做了BeforeInvoke、AfterInvoke、OnException三種Method，可讓開發人員輕易的實現自己想實現的Attribute。

嚴格說起來，我們用PIAB這樣的手法雖然可以實現部份AOP的目標，但還夠不全面，這也是PIAB不稱自己為AOP框架的原因。但是，即便只是能實現到目前這樣，也已經很符合我們在日常開發工作當中使用了。

這篇先寫到這邊，改天我們來談談如何實現OnException的Attribute。

完整程式碼可以參考:
https://github.com/isdaviddong/isRock.Framework.AOP-Examples

參考資料:
Introduction to the Policy Injection Application Block

-----------------
相關教育訓練: http://www.studyhost.tw/NewCourses/Architecture
若這篇文章對您有所幫助，請點選這裡加入FaceBook專頁按讚並追蹤，也歡迎您幫我們分享出去，謝謝您的支持。

留言

張貼留言

這個網誌中的熱門文章

使用LM Studio輕鬆在本地端以API呼叫大語言模型(LLM)

作者： -
圖片
最近上課常被問到，如何在地端環境搭建出大語言模型(LLM)，並且呼叫其API。 一開始我不太理解為何會有這樣的需求(因為在地端自行搭建運行LLM的成本不一定比較低，即便可能比較安全)，但被問多了，也就開始遍尋相關的解決方案，看看有沒有什麼最簡單的方式，可以讓開發人員在地端測試大語言模型? 後來我選擇 LM Studio ，它就是一款設計來運行大型語言模型（LLM）的平台，有個算是挺優雅的整合環境，讓一般 end-user 或開發人員，都可以輕易地在 local 端進行模型的部署和測試。 LM Studio 本身支援多種模型架構和框架，當然，最重要的是，它是免費的。 下載安裝 都很容易，我就不多說。 安裝好之後，你可以看到首頁中已經呈現了許多 Hugging Face上的模型： 這顯然是因為Hugging Face是大部分免費開源模型的集散地。 你可以搜尋自己喜歡的模型，透過LM Studio下載到local之後，就可以直接載入(下圖一)： 隨手設定一下 system prompt(上圖二)，然後，就可以直接對談了。(上圖三) LM Studio會使用你的GPU進行運算(如果有的話)，你會發現，原來有好的設備(GPU)，運行的速度可以如此之快。 Local Server 對於開發人員來說，它還有個超級更友善的功能。 LM Studio本身還提供一個 local server，可以幫你把模型包裹起來讓你直接透過API呼叫該模型的功能，例如： 上圖是我們開啟 LM Studio中 Local Server功能後的結果，你可以透過 localhost 的 1234 port 來呼叫這個被 LM Studio 運行起來的大語言模型。(有沒有發現，我們用的也是 chat/completions API) 透過Postman簡單提供一下 JSON Body: { "model": "LM Studio Community/Meta-Llama-3-8B-Instruct-GGUF", "messages": [ { "role": "system", "content": "你是AI助理，請一律用繁體中
Read more »

VS Code的字體大小

作者： -
圖片
身為.net developer，這年頭是什麼code都得要會寫的年代。 而雖然我的NB還沒從Windows淪陷為Mac OS，但寫Node.js和Python免不了要用VS Code，這是一種愛的表現。 但歲月不饒人，盡管微臣非常熱於配合，但VS Code預設字體的大小在我還沒錢買大尺寸螢幕的狀況下，實在讓老臣難以適應。當下的第一個反應是什麼? 當然是 Ctrl+滑鼠滾輪往上推…哇靠，沒用。看…這設計…恩，千錯萬錯一定是我的錯。 只好從選單 file –> Preferences –> Settings: 在出來的視窗中，你可以看到 editor.fontsize: 沒錯，改它就行了。改不動? 喔，不好意思，我沒仔細看說明，要copy到右邊是吧，沒問題，copy->paste->modify->Save…搞定。 好簡單啊…連ctrl+(mouse scroll up)都用不到了呢… 咦?這是一篇抱怨文嗎? 沒有，誰說的? 免費的tool我們還有什麼好抱怨的呢…要感恩啦。 啊….對了，如果你還是堅持要使用 Ctrl+滑鼠滾輪，請找關鍵字… "editor.mouseWheelZoom"
Read more »

使用 Dify 建立企業請假機器人

作者： -
圖片
八卦與未來 上個月，前Google執行長Eric Schmidt在史丹福有場演講，媒體關注的是八卦消息(如果你也曾關注，網路上有很多鐵定可以找到)，但我注意到的則是他提到了自己認為接下來 AI(特別是大語言模型) 可能的發展方向，包含: Large Context Window AI Agent Text-to-Action 底下這邊有這一個段落的影片： https://www.youtube.com/watch?v=zl3k1ksFZdY 為何我會關注這部分? 因為上述的三個方向，也是身為開發人員的我，過去這一年，來與LLM打交道後的感想。昨天，我在 twMVC 的研討會分享中，展示了一個其實我過去早做過了N百次的範例，就是企業的請假機器人。(唯一不同的是，這次我幾乎沒有寫任何程式碼) 場景是，員工在家裡生病了，想要透過語音或是app進行請假，你可以看底下這個運行的範例 (git圖檔會循環播放，開始是 『我好像感冒了』)： 用自然語言對談的方式，即可完成請假。 我說過，類似這樣的範例我做過很多次，用 LINE Bot 搭配 C# 做過，用MS Bot Framework 做過，前陣子也用 Semantic Kernel 框架做過，更早期，還沒有AI的時代，我也在EIP和HR系統裡做過。 但我想說的是，這 就是 Text-to-Action 的呈現，也是一個典型的 AI Agent 的例子，它讓我們透過自然語言(可以是語音或文字)，直接命令機器人(Chat Bot、AI 助理、Agent、Assistant …不管你叫它什麼…)幫你完成一件事情(請假、售票、查詢資料、做財務報表、統計圖表、寫程式…etc.)。 這是一直以來人類對電腦最底層的需求與期待。 隨著 LLM 能夠處理和記憶的 Context 愈來愈被放大，AI Agent 所能夠處理的任務就更加的不受限制。 自然語言才是最符合人類直覺的操作 順帶一提，我昨天在研討會中講了一個故事。 有天，你覺得自己需要聘請一位助理，因此上網張貼徵人啟事，沒多久，你找到了一位號稱上知天文、下知地理的高材生，來幫助你更有效率的完成工作。 他什麼都好，唯一的一個小缺點是，你不能直接對這個助理下達指令，你必須用一種只有這個助理看得懂的語法，才能要求這個助理幫你完成特定的工作。這些語法還挺
Read more »

使用Qdrant向量資料庫實作語意相似度比對

作者： -
圖片
什麼是向量資料庫? 在許多的AI實作當中，都有向量資料庫的使用需求。例如RAG(檢索增強生成)、或是資料的相關性比對、相似性搜尋…等，這些應用情境中，我們都會用到向量資料庫。 向量資料庫主要的任務，當然就是存儲和查詢向量數據。被儲存的向量數據通常是高維度的資料，以陣列(集合)的形式呈現。 例如，OpenAI就有提供一組Embedding API，讓我們可以把文字給向量化。你可以透過該 API，把一句話(一段文字)轉換成向量數據，類似底下這樣： OpenAI 的這組 Embedding API，在預設狀況下，會把資料轉成 1536 維度的向量數據，其背後的行為是把文字送給一個訓練好的模型，透過該模型跑出這組向量數據，再回傳給用戶。 然而，把一段文字給向量化的目的是什麼呢? 當我們把文字做了這種轉換後，在 1536 維度的座標空間(向量數據)中，愈相似的文字，透過Embedding API會得到距離愈接近的座標點，藉此，我們得以迅速的判斷兩段文字在語意上的相似性。 而向量資料庫中所謂的查詢功能，主要就是向量的檢索，像是『近鄰搜索（Nearest Neighbor Search）』，當用戶或應用程式提交一個向量查詢時，向量資料庫會幫我們找出資料庫中，與之最相似(接近)的向量座標點。 因此，開發人員只需要透過 Embedding API，把文字轉成向量，再把轉換好的向量座標值，儲存到向量資料庫之中，未來就可以透過向量資料庫來查詢相似(接近)的文字。 關於這個部分，如果讀者有興趣，前陣子有段網路上的影片把多維度向量資料庫的概念介紹的蠻清楚的: https://www.youtube.com/watch?v=W_ZUUDJsUtA https://www.youtube.com/watch?v=ct20Kv8yn0U 為何需要? 向量資料庫最實務上的應用，就是找到類似的特徵值。 例如，當我們把人臉的特徵值以向量資料的形式儲存到向量資料庫中之後，我們就可以透過資料庫本身提供的搜尋功能，快速地尋找出相似的人臉，這也是許多AI應用實現的基礎。 我們底下的程式碼範例，則是找出最接近的問題。(呃…什麼意思?🤔 請往下繼續看) 我們在建立對談機器人時候，常常需要讓機器人回答用戶的問題。這時，我們會讓用戶輸入問句，然後透過 Embedding API
Read more »

使用C#開發LineBot(3) - 使用LineBotSDK發送Line訊息

作者： -
圖片
新版的Line Messaging API，要主動發送訊息給用戶不是很困難，主要是透過Push API，可以參考底下的官方說明 : https://devdocs.line.me/en/#push-message 另外，如果你想申請一個Line Bot，可參考: 關於LineBot (1) - 用c#建立一個LineBot 前陣子說過，我們為了團隊開發方便，做了一個 Nuget Package 以便於讓撰寫C#的開發人員可以方便的進行Line Messaging API的操作。 所以，如果你想要透過該SDK來發送訊息給用戶，可以透過底下的指令: isRock.LineBot.Utility.PushMessage(               UserId, 要傳送的訊息, AccessToken); 別忘了使用前，要先引用linebotSDK這個套件: 當您在.net 4.x的專案中，安裝上述lintbotSDK，即可透過前面提到的指令發送訊息給用戶，但請注意，該用戶必須加你的bot為好友。 你可能在使用時會碰到一個問題，怎麼知道用戶的id呢? 請注意，PushAPI的Line用戶id並非你的line ID，而是一長串項是底下這樣的id: U6OX388eOX3634X2OX2e341OX06b8OX4123 這個ID會在你的用戶跟你的bot交朋友，或是對談的時候，由系統傳送給你所設定的WebHook網址(其本質上是一個asp.net WebAPI或類似的API服務)。你會在Line傳遞給該WebHook URL的封包中的JSON形式資料內獲得。 也就是說，當你的用戶傳訊息給你的Bot，或是與你的Bot做朋友(或封鎖)，你所在你的LineBot後台，所設定的這個WebHook，都會收到這些相關的訊息。其設定位置如下: 訊息內容是以JSON的格式出現。 但是，如果你還不知道怎麼寫一個WebHook，該怎麼辦呢? 寫個WebHook其實很簡單，以asp.net來說，就是寫一個asp.net WebAPI即可。(有空我再說明，但今天比較沒空) (2017更新，WebHook開發方式請參考 這裡 ) 如果你沒空寫，可以先用底下這個工具(注意這個工具 僅限測試使用 ，我們不保證其穩定性與可用性、與資料安全性): http://isbaas.azurewe
Read more »