abp-CMS模組-廣告

變形精怪發表於2020-06-13

無論是開發app還是網站，可能都需要一個廣告功能，比如我們常見的在首頁有個輪播廣告，裡面會輪播顯示多個圖片。還有比如一個新聞入口網站 很常見的 banner橫幅廣告，還有js特效廣告等。本篇說說在abp(5.9)中如何實現廣告模組。

原始碼地址：https://gitee.com/bxjg1987/abp 基於abp一代5.9版
線上演示：http://git.weilaikj.cn/  賬號密碼 admin  123qwe

廣告位

它代表某個頁面上，某個位置，比如：首頁頂部用來放輪播廣告那個位置。再比如：新聞列表頁右側廣告位。廣告位有個名字屬性，還有尺寸相關的屬性

廣告控制元件

它是在頁面用來展示廣告的頁面元件定義，比如：圖片輪播控制元件。再比如：靜態圖片展示控制元件。

這裡的控制元件只是定義某個控制元件，在資料庫表中就是一條記錄，定義了控制元件名、控制元件型別（輪播、靜態圖、普通文字）、控制元件引數等屬性。前端可以根據這些資料來定義介面。因為可能有不同的前端，就算同樣是pc網站前端，我也無法限制你將來用什麼樣的形式來展現一個輪播圖片的控制元件。所以我只能把後臺定義的輪播圖片控制元件的相關引數給你，至於如何使用這些引數來顯示輪播控制元件，只能由你來實現了。

廣告

它就表示一個廣告，這就代表廣告主將來要投放的廣告。比如客戶提供的一張圖片。它有廣告標題、廣告型別（是圖片？文字？一段html？一段js？）廣告內容（比如是圖片型別廣告，則它儲存圖片的url）、URL（點選廣告時要跳轉到哪去）

廣告發布記錄

它是上面3個概念的多對多關係的建立，它是一條廣告發布記錄。什麼時候，釋出哪個廣告，使用什麼樣的控制元件，釋出到哪幾個廣告位。如：有個圖片廣告 要顯示到 首頁輪播控制元件中，同時顯示到新聞列表頁右側，用靜態圖片廣告控制元件展示

廣告 與 廣告發布記錄 合併

目前沒有這樣處理，不過可以說說思路。廣告、廣告位、廣告控制元件，最後通過廣告發布記錄將它們多對多關聯，這樣的設計非常靈活。但是也相對複雜。可以考慮將廣告和廣告發布記錄合併，這樣就沒那麼靈活了，比如同一個廣告要同時釋出到多個廣告位（首頁和列表頁和內容頁，甚至是多個欄目的不同位置都有同時顯示某個廣告）。或者同一個廣告要用不同的控制元件展示時。合併這倆概念要實現前面說的這種需求，就需要將同一個廣告多次釋出，其實本質上就是兩個廣告，只是廣告內容一樣

cms模組中的廣告原始碼簡述

首先在CMS/BXJG.CMS.Core/Ad中建立上面各概念對應的實體類：廣告位(AdPositionEntity)、廣告控制元件(AdControlEntity)、廣告(AdEntity)、廣告發布記錄(AdRecordEntity)等實體

然後在CMS/BXJG.CMS.EFCore/EFMaps中建立相應的ef對映檔案 xxMap.cs

然後在CMS/BXJG.CMS.Application/Ad中建立應用服務介面及實現，當然還有對應的dto物件。這裡需要注意，系統管理員需要在管理後臺對廣告進行管理，比如定義廣告位、對廣告的增、刪、改、查、釋出、撤銷等操作。網站或app或小程式前臺展示廣告時則是不需要使用者登入的，匿名使用者應該也可以看到這些廣告。所以這裡將 分別定義後臺和前端對廣告的處理對應的介面，而不是定義在同一個介面中。具體來說IBXJGCMSFrontAdRecordAppService是專門給前端用的介面，裡面只包含對廣告的查詢功能。IBXJGCMSAdAppService則是給後臺對廣告進行管理的介面，裡面包含對廣告的增、刪、改、查、釋出撤銷等，不過寫文章時此介面和實現還沒有做。

下面按abp的套路定義許可權和選單

到此cms模組中的廣告功能基本定義完成。

如何整合到主程式

上面大致說了下cms模組中的廣告功能相關原始碼。在我們的專案中模組與主程式儘量獨立。CMS是我們定義的一個內容管理模組，廣告只是下面一個功能。原始碼中的ZLJ.XXX是我們的主程式。這個主程式會來整合不同的模組，廣告模組就是其中之一。你也可以在你的abp專案中來單獨引入這個廣告模組，只是目前這個模組沒有釋出成nuget包。

下面說說如何在我們主程式中使用cms模組中的廣告功能

在ZLJ.EntityFrameworkCore/EntityFrameworkCore/ZLJDbContext中定義廣告相關實體的 DbSet

public virtual DbSet<AdEntity> BXJGCMSAds { get; set; }
public virtual DbSet<AdControlEntity> BXJGCMSAdControls { get; set; }
public virtual DbSet<AdPositionEntity> BXJGCMSAdPositions { get; set; }
public virtual DbSet<AdRecordEntity> BXJGCMSAdRecords { get; set; }

此時進入api頁面可以看到廣告服務介面https://git.weilaikj.cn/swagger/index.html，可以測試了。（開啟頁面，Ctrl + F搜尋"BXJGCMSFrontAdRecord"）

在主程式中整合模組時，手動在主程式的DbContext中定義DbSet比較繁瑣，網上有動態向DbContext加入DbSet的方法，著名的微信庫Senparc的SCF應該就是那種方式，不過我還不會。還有一個原因，有時候我們需要主程式在整合模組註冊DbSet時提供實體泛型引數，手動方式最直觀。（動態DbSet應該也可以指定實體泛型引數）

由於廣告模組足夠簡單，它不需要引用主程式的某些概念，也沒有考慮給模組呼叫方提供擴充套件廣告、廣告位、廣告控制元件等的能力，因此在主程式整合廣告功能就很簡單。如果將來考慮允許模組呼叫方通過繼承的方式，來為廣告新增更多自定義屬性，可以考慮在廣告相關的應用服務中，將廣告（AdEntity）變成泛型的。將來由模組呼叫方來提供一個繼承至AdEntity的子類

另一種情況是模組內部需要引用主程式的提供的一些概念時，比如 AdEntity中需要引用主程式中的XXX類，作為導航屬性，那麼AdEntity本身就需要定義成泛型的AdEntity<xxx>，這樣模組內部就不要直接依賴主程式的某個類，而是由將來主程式呼叫時指定

這裡說的兩種情況後續會專門寫一篇來介紹，目前shop資料夾中相關原始碼已有體現。

前端處理

通過IBXJGCMSFrontAdRecordAppService介面，前端頁面可以獲取當前釋出的廣告資訊，裡面包含了廣告位、廣告控制元件、廣告、釋出相關屬性，前端可以根據這些資料自由控制前端廣告的展示。這部分功能模組沒有也很難提供。

結束

這裡簡單介紹了下專案中設計的abp cms模組中的廣告功能，這個設計參考了部分cms系統，目前只有個骨架，後續會逐步完善。目前專案中類似的模組還有幾個，沒來得及寫說明。後續再補充吧。希望找到熱愛abp的朋友，一個做模組，互相分享，因為我們可能在做一樣的功能，沒必要重複勞動。

目前的目標是開發常用，簡單、實用，不考慮擴充套件性的模組，將來逐步實現擴充套件性　　

 

相關文章