二次開發
提示:文檔中心正在完善中,我們將不斷發布新文檔,敬請期待...
SiteServer CMS 5.0 源碼入門
一、准備開發環境
想學習SiteServer CMS的或者想利用SiteServer CMS源碼進行項目定制開發的程序員,需要提前准備好開發環境。具體要求如下:
1、.net framework 4.5.2或以上版本;
2、Visual Studio 2015或以上版本;
3、SQLServer 2008及以上版本或MySql 5.0 及以上版本;
4、NodeJS 最新版(可選);
說明:如果需要修改用戶中心的前台頁面代碼,或者需要重新制作安裝包或升級包,才需要安裝NodeJS。
二、獲取代碼
官方在GitHub上提供的源碼,地址為:https://github.com/siteserver/cms
通過Git命令或者從上圖頁面直接下載最新源碼。
產品使用文檔或開發文檔,請關注官方的開發者中心:http://developer.siteserver.cn/
三、源碼結構初析
1、解壓源碼壓縮包
注意:如果只修改SiteServer CMS后台功能或后台界面的話,只需要關注source文件夾里的代碼即可。
2、Visual Studio 打開C#代碼
注意:
-
SiteServer.API 項目對應源代碼解壓出來的文件夾是source文件夾下的SiteServer.Web文件夾,並沒有一個名叫SiteServer.API的文件夾。
-
SiteServer.API 並不是提供給第三方系統與SiteServer數據交換用的,而是SiteServer系統內部使用的一些API接口,比如用戶中心現在前后端完全分離,前端用ReactJS來實現,和后端的數據交換就是通過SiteServer.API來實現的。
-
SiteServer.Plugins才剛剛開始,標准格式還沒完全定下來,現在官方已經開發了第一個插件:阿里雲存儲插件,即站點文件可以支持雲存儲。具體源碼在:https://github.com/siteserver/Plugin.Oss
四、安裝SiteServer CMS
1、新建空數據庫,設為啟動項目
在Sql Server Management Studio中新建名為cms5.0的空數據庫。在Visual Studio中把SiteServer.API設置為啟動項目。
2、安裝SiteServer CMS
如果是下載完源碼第一次運行程序,則會需要進入安裝SiteServer CMS的流程。具體是在Visual Studio中按F5開始調試,出現如下空白界面:
然后在瀏覽器地址中后面加入/siteserver,再回車,即地址變成:
http://localhost:58059/siteserver,則會出現如下安裝界面:
按界面提示點下一步即可完成安裝。具體安裝說明可參考:http://docs.siteserver.cn/getting-started/index.html
安裝完成之后點擊進入后台管理,需要新建站點,如下圖:
輸入站點名稱即可以創建一個空的新站點,並自動進入后台站點管理界面:
五、開始修改調試源代碼
經過前面的操作,我們已經把SiteServer CMS運行起來了,並已經經入了調試狀態。現在我們就以一個具體例子來演示一下如何進行代碼修改並調試。
任務:把下圖中的紅框內容部分改成“歡迎使用SiteServer CMS 管理后台”
1、找到對應前台頁面文件
運行程序,登錄后台,進入到主界面。然后在紅框位置按鼠標右鍵,點擊“查看框架源代碼”,彈出如下圖:
通過上圖可以看到,本頁面路徑是在siteserver文件夾里的pageRight.aspx文件,好對應源代碼解壓出來的位置就是:source\SiteServer.Web\SiteServer\pageRight.aspx。此時我們可以通過Visual Studio、Visual Studio Code或Atom編輯器打開此文件:
通過上圖兩個黃框,我們可以找到兩個重要信息:
一個是控制pageRight.aspx文件業務邏輯的CS代碼文件類:SiteServer.BackgroundPages.PageRight;
另一個是顯示歡迎信息的asp.net服務器控件ID為LtlWelcome。
2、找到前台頁面對應的后端c#代碼文件
通過前一步找到控制pageRight.aspx文件業務邏輯的CS代碼文件類是SiteServer.BackgroundPages.PageRight,這很清楚就是在SiteServer.BackgroundPages項目中,在Visual Studio中很容易就找到PageRight.cs文件:
在Visual Studio中打開PageRight.cs文件:
很清楚就看到了控制顯示歡迎信息的服務器控件LtlWelcome。
3、修改並調試代碼
在修改代碼之前需要停止調試,然后把代碼進行如下修改,並設置斷點(F9),然后啟動F5運行程序並進入調試狀態,登錄之后會是這樣:
點擊繼續之后,出來的結果就是這樣:
至此,我們就完成了開始提出的修改任務,並也能斷點進行調試。