opencms 发布过程深入研究

引入：

比起创建Resource，发布过程要困难很多，我上周在support team时候曾经设想不通过调试器，光走读代码来明白其中的奥秘，后来因为堆栈太深而放弃了，现在有了调试器，终于把这些细节弄明白了，果然非常复杂。

细节分析：

在发布Resource时，它的入口是CmsPublishProject类的actionPublish()方法，发布过程复杂到变态，全包装在performDialogOperation()方法中：

宏观上看，它先获得workplace中所有资源的发布列表，因为本例中只有一个资源，所以调试的列表如下：

其次，它通过CmsPublishManager的publishProject()方法来做对于待发布列表的资源的发布工作。

CmsPublishManager会调用CmsSecurityManager的publishProject()方法，最终调用CmsDriverManager的publishObject()方法来做发布的全部工作。这就是我们要讨论的重点。

重点探讨1： 从CmsDriverManager的publishObject()方法来研究发布过程。

发布过程代码很多也很深，从宏观上看，它做了这么几件事情：

a.  检查父目录，这主要用于是否存在该资产的父目录还没被发布的情况。

b.发起一个CmsEvent类的发布前事件（beforePublishEvent）,该事件中除包含上面的发布资源列表(publishList)外还包含projectId,dbContext和一个空的发布报告对象(CmsHtmlReport,用于存储发布失败的错误),该事件中的数据如下：

然后用CmsEventManager的fireCmsEvent(beforePublishEvent)方法来执行这次发布事件。

因为一个资源的发布会影响到opencms的其他组件的更新，所以这里使用“Observer”设计模式，它吧多个cms的其他组件加到CmsEventManager的监听器列表中，监听器有几百个，我就不一一列出了。

c.用发布锁CmsLock锁住所有发布列表中的资源。

d.调用CmsPublishEngine的enqueuePublishJob()方法来记录下发布的计划任务，并产生具体的发布报告。具体来说：

1.   它创建一个具体的CmsPublishJobInfoBean对象，它其中包含了发布所需的全部细节：

  2. 调用CmsPublishQueue的add方法吧这个发布作业对象添加进去，它在其中会调用CmsDriverManager的createPublishJob()方法来创建具体的发布作业，最后会调用CmsProjectDriver类的createPublishJob()方法来做具体的数据库层面的操作。

其最后执行的SQL语句是：

所以从这里看出，它会更新CMS_PUBLISH_JOBS表，把发布的若干信息，比如发布历史ID，项目ID，名称，用户ID，发布国际化标示，入发布队列时间，发布开始时间，结束时间，以及发布的列表都插入数据库。

3.调用CmsPublishListenerCollection的fireEnqueued()方法来把这次发布事件通知所有的监听组件，如果发布过程失败，则从CmsPublishJob的publishReport中可以拿到发布错误信息。

e.调用checkCurrentPublishJobThread()方法来做具体的站点发布。因为这里是多线程操作而不是同步走下去的，所以开始几次调试每次都找不到执行点，后来研究了下，发现具体的站点发布代码放在CmsPublishThread的run()中，它最终会调用CmsProjectDriver类的publishProject()方法来执行具体的发布。

1. 它首先调用CmsHistoryDriver的writeProject()方法把指定的Project写入CMS_HISTORY_PROJECTS和CMS_HISTORY_PROJECTRESOURCES表：
   

写入CMS_HISTORY_PROJECTS表的SQL语句如下：

写入CMS_HISTORY_PROJECTRESOURCES表的SQL语句如下：

2.它会执行具体的内容变更，它会遍历发布列表publishList, 然后对其中的目录和文件分别发布，其中目录在先。对于目录的发布，它是调用以下代码来实现：

而对于文件的发布，它是调用以下代码来实现：

重点探讨2：发布文件的过程（其实发布目录差不多一样，只不过因为我用文件做例子，所以只能调试出文件的发布细节了）

总的来说，CmsProjectDriver类的publishFile()方法会调用CmsProjectDriver类的publishNewFile()方法，进而调用CmsProjectDriver类的publishFileContent()方法来执行具体发布的，具体步骤如下：

a. 从CMS_OFFLINE_CONTENTS表中获取给定ResourceID的内容。

它执行的SQL语句是：

b.从上步骤的Resource构建offlineFile， 并且克隆到newFile中。

c.创建cms的online resources和online structure 。通过以下代码：

其中更新CMS_ONLINE_RESOURCES的SQL语句如下：

更新CMS_ONLINE_STRUCTURE的SQL语句如下：

d.接着上一步，更新cms的online resources和online structure的版本号。通过以下代码：

其中更新CMS_ONLINE_RESOURCES的版本号的SQL语句如下：

更新CMS_ONLINE_STRUCTURE的SQL语句 如下：

e.创建online文件的内容。通过以下代码：

它执行的SQL语句如下：

f.创建online文件的properties信息。通过以下代码：

它会把去写CMS_ONLINE_PROPERTIES文件，因为我的发布的文件没有配置properties,所以调试器跳过了这一段。

g.写入新的online访问控制列表。通过以下代码：

它最终会去写CMS_ONLINE_ACCESSCONTROL。

最终，发布过程成功，前端会有一个模态对话框总结下这次发布：

总结：

(1)发布过程宏观上分为发布作业的记录和实际站点发布工作。

(2)发布过程是以事件驱动的，其发布涉及到的信息资源记录在beforePublishEvent中。

(3)发布作业会维护一个作业队列，然后把发布事件添加到发布队列中。发布作业的执行会更新CMS_PUBLISH_JOBS表。

(4)发布作业的结果会通知所有监听器，这些监听器是opencms的自带组件。

(5)对于实际站点发布的工作，是另开了线程来完成的，其线程使用的执行体是CmsPublishThread类。

(6)发布线程会把当前Project信息写入CMS_HISTORY_PROJECTS和CMS_HISTORY_PROJECTRESOURCES表。

(7)具体目录和文件的发布工作，是通过发布线程遍历待发布列表来依次执行的，先执行目录发布工作，再执行文件发布工作。但两者类似。

(8)执行文件的发布会从CMS_OFFLINE_CONTENTS表中获取给定ResourceID的内容,构建offlineFile,并克隆到newFile中，然后依次创建CMS_ONLINE_RESOURCES，CMS_ONLINE_STRUCTURE文件，并更新其版本号。再在以下表（CMS_CONTENTS,CMS_ONLINE_PROPERTIES,CMS_ONLINE_ACCESSCONTROL）中分别创建新条目。