SiteServer CMS 5.0 源码入门
二次开发
提示:文档中心正在完善中,我们将不断发布新文档,敬请期待...
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运行程序并进入调试状态,登录之后会是这样:
点击继续之后,出来的结果就是这样:
至此,我们就完成了开始提出的修改任务,并也能断点进行调试。