opencms建站手册

1.Opencms介绍和环境搭建 (1)

1.1简介 (1)

1.2环境搭建步骤 (2)

1.3文件结构 (2)

1.4关于虚拟文件系统 (3)

2.Opencms常用API和常用标签的使用 (3)

2.1预先说明和准备。 (4)

2.2举例 (5)

2.2.1功能描述 (5)

2.2.2实现过程 (5)

2.3常用API (7)

2.3.1常见对象和方法 (7)

2.3.2常见的sample程序 (8)

2.4常用标签 (8)

2.4.1 (8)

2.4.2 (9)

2.4.3 (10)

2.4.4 (10)

2.4.5 (10)

2.5 例子扩展 (11)

2.5.1 扩展说明 (11)

2.5.2 实现过程 (13)

3.建站过程 (20)

1.Opencms介绍和环境搭建

1.1简介

Opencms是一个内容管理系统，是一个完全开源的软件，由德国的Alkacon Software 公司负责OpenCms 的开发和维护，适合网站的建设，比如门户网站等等，但不适合业务系统的建设。

内容管理系统（CMS）的基本思想是分离内容的管理和内容的展示（页面设计）。

页面设计存储在模版里，而内容存储在数据库或独立的文件中。当一个用户请求页面时，模版和内容联合起来生成一个标准的 HTML 页面，然后返回给用户。

其优点：a) 完全基于Java/XML 技术，能够很容易的集成到现有的应用环境中。

b) 易于安装，利用浏览器页面就可以进行安装, 基于浏览器的工作环境，不需要

安装任何软件。

c) 可以在一个OpenCms 系统中管理多个站点。

还有很多优点，慢慢体会更好。

1.2环境搭建步骤

首先要具备java开发环境（即jdk的配置），数据库（MySQL或者Oracle等，这里我用Oracle11g举例），Tomcat环境，opencms 的war包。

将war包放到Tomcat的webapps目录下，启动Tomcat后在浏览器中运行http://localhost:8080/opencms/setup/，在数据库的页面中setup Connection和Opencms Connection要分别写system用户和OpenCms 安装后工作时使用的用户。之后Continue到安装成功。

Opencms的默认主页是http://localhost:8080/opencms/opencms/index.jsp

Opencms的登录主页http://localhost:8080/opencms/opencms/system/login/

首次登陆的用户名密码：Admin/admin（注意大小写敏感）

登录之后会看到工作区。

当前之后我们需要将第一个opencms去掉，让登录的地址变为http://localhost:8080/opencms /system/login/

1.3文件结构

Opencms的文件结构如下:

我们主要对opencms的一些配置文件进行配置，该目录位于WEB-INF/config目录下。

主要的四个文件：

opencms.properties--这个文件包含连接数据库的配置信息。根据安装过程中用户的输入，安装程序会自动生成此文件。

opencms-importexport.xml--这个文件控制从VFS中导入和导出文件。(VFS等下会稍微描述)

opencms-modules.xml--这个文件包含着模块的注册信息，并由工作区管理视图中的模块管理工具来管理。这个文件中的设置，不应该手工修改。

opencms-system.xml--这个文件包含了系统核心设置，比如区域设置、缓存和网站定义。很多设置需要手工进行。

其中opencms-modules.xml和opencms-system.xml是很重要的。

1.4关于虚拟文件系统

以Admin登陆并选择根站点（/），这下面有2个目录，分别是：

sites: 这个分支下面的每个文件夹代表一个OpenCMS网站。正是通过这个机制来隔离网站内容的。每个文件夹的title属性会出现在工作区资源管理视图的Site下拉列表中。

增加一个站点包括两个手工步骤：首先在VFS中建立一个文件夹。然后，在opencms-system.xml中添加一个site条目。每个增加的site条目必须有一个唯一的域名或IP地址。当一个针对这个域名或IP的请求到达OpenCMS，OpenCMS会设置site上下文，进而使得对这个文件的请求看上去是相对于站点的根的。比如，如果站点https://www.360docs.net/doc/5f7813321.html,指向了/sites/mysite/ 那么一个对于该域名index.html的请求会看上去像是位于“/”下。

system: 这个文件夹包含了构成OpenCMS工作区资源管理视图的主体文件。我们只要操作的是modules，它只要包含模块和相应模块资源的子文件夹。

2.Opencms常用API和常用标签的使用

对这部分我首先贴出一个我做一个简单Demo的过程，之后再建站过程再对这个Demo 进行延伸，最后再分别讲述一些常见的API和常用的标签。

2.1预先说明和准备

说明：我在tomcat下webapps目录：

其中sicms是我的opencms目录（其实这里的意思很容易理解，装好opencms之后我们访问那个登录页面是http://localhost:8080/opencms/system/login/,如果我们将那个opencms的目录名字该做sicms，然后对tomcat和opencms里面的配置文件对应起来，不就是http://localhost:8080/sicms/system/login/呢，之后通过配置也可以变为http://localhost:8080/sicms/qhylbx/system/login/，当然这就是我当前的访问地址,详细的配置过程后面会贴上各个配置文件）。

在网上下opencms的eclipse插件，注意eclipse的版本，如果版本太高是不行的。

我用的MyEclipse6.0.1。下面是MyEclipse的一些配置

装好插件之后New->Other->OpenCms Module,”Fetch”就能抓取到module。

2.2举例

2.2.1功能描述

现在我要做一个门户网站的“局长信箱”的功能，就是浏览门户网站的人可以对局里各个部门发邮件，在邮件过程中会产生一个查询码和密码，局里人回复后可以查询到自己的内容。

a)首先，页面如下：

b)点击“局长信箱”，页面如下：

这个Demo很粗糙很简单，千万别笑哈。。。

2.2.2实现过程

a)建文件目录

其中demo是我的一个站点，module_jzyx是站点下属于局长信箱的目录，下面存储的都是局长信息的一些文件，下面的三个目录代表局里不同的部门，在发邮件的时候，发给不同部门的邮件会分别放在不同的目录下。其中如办公室下面的邮件有：

b)建module。

在“系统管理视图”中的“模块管理”中建立一个新的module

Module名称com.powersi.demo.applyOpen

看情况选择创建“子文件夹”：

此时在MyEclipse 就能搜索到这个对应的module，如果fetch的很快代表没有fetch最新的，请重启MyEclipse和Tomcat就能fetch到最新的。以后我们对页面的内容的管理就在MyEclipse 中，这些页面将又站点下的文件对应。

c)创建显示的页面和显示模板

在/sites/demo/下面创建index.html

在/system/modules/com.powersi.demo.applyOpen/templates/下面创建index.jsp，index.jsp中就是一个链接

局长邮箱

其中标签的作用后面标签中讲到，这里是指向index.jsp当前目录下的gover_query_page.jsp.

然后将index.html指向index.jsp,右击“index.html”，“属性”->”高级”。

之后点击index.html是不是看到显示的是index.jsp中的内容呢!!!

之后编辑gover_query_page.jsp页面就和编辑jsp一样了！看到这里，是不是觉得原来就是一个页面和模板的对应关系呢？？但是，你也许会问，如果点击“信件投递”产生的信件放在哪里呢？存在数据库么？当然这是后面慢慢会延伸的内容。

2.3常用API

2.3.1常见对象和方法

CmsObject：主要提供对VFS资源的访问，里面有很多方法非常常用；

getSubFolders(resourcename)：获取某条路径下的子文件夹。

getFilesInFolder(resourcename):获取路径下的所有文件

readResource(resourcename):读取文件(此时特别要注意，这个方法不能读取文件夹，所以读资源之前一定要判断)

getRequestContext()：得到上下文

cms.createResource(resourcePath, 141):创建某种类型资源，141是文件类型，这个类型配置在operation-module.xml中。

cms.unlockResource(resourcePath)：资源解锁

cms.lockResource(resourcePath)：资源加锁

readFile(resourcePath), writeFile(cmsFile):读取路径下的文件，写文

件

CmsResource:是VFS资源类的父类，一般文件系统的资源包含文件和文件夹，所以CmsFile和CmsFolder的父类。

isFile(),isFolder()：判断为文件还是文件夹

CmsFile:提供VFS文件的访问。

setContents(byte[]),getContents():设置和获取文件的内容。

CMsFolder:提供VFS文件夹资源的访问。

CmsRequestContext:存储一些Opencms的上下文信息，可由CmsObject获得。

这些都是些访问资源的类。

setAttribute(key, value)：设置属性

setSiteRoot(root)：设置站址

2.3.2常见的sample程序

初始化CmsObject的程序：

protected static CmsObject getIniCms() throws Exception {

CmsObject cms = OpenCms.initCmsObject("Guest");

cms.loginUser("Admin", "powersiqhylbx");//登录的用户名密码

org.opencms.file.CmsProject cmsProject =

cms.readProject("Offline");

cms.getRequestContext().setCurrentProject(cmsProject);

return cms;

}

获取数据库连接的程序：

protected static Connection getConnection () throws SQLException{ CmsSqlManager sqlManager = OpenCms.getSqlManager();

Connection connection = (Connection)

sqlManager.getConnection("default");

return connection;

}

2.4常用标签

2.4.1

利用该标签可以为VFS 中的资源建立有效的URL,这样就不用考虑Web 应用名和

Servlet 上下文等复杂的技术细节，减少了错误的发生，提高了工作效率。

比如：

action="./sub_jzyx/gover_query_process.jsp">

onclick="location.href='./sub_jzyx/gover_send_mail.jsp';">投递信件

2.4.2

这个标签用来读取指定的一个或多个XML 内容文件。(一定要记住VFS中的文件都是以XML的方式读取的，比如一个文件，一个文件夹在读取的时候都是一个XML字符串)，其中属性Collector为singleFile为读取单个文件，为allInFolderDateReleasedDesc代表读取多个文件，按照文件的Date Release排序，当然还有很多其他的值，可以参考文档。属性param 代表符合表达式的文件名。在param中，%(property.xxx)代表取当前jsp文件的某个属性值，%(opencms.uri) 表示当前请求的XML 内容文件的URI，使用该宏时，一般把collector 设置为singleFile，[filename]|[resource type]|[count]这种形式中，文件名，通常使用宏“%(number)”来表示多个文件，resource type表示资源类型名，count代表个数。

比如：

显示某个目录下的单个文件，如果当前jsp的article-folder的属性为

/sites/demo/module_jzyx/，那么显示的就是/sites/demo/module_jzyx/bgs/ goverMail_111.html的文件的内容.

param="%(property.article-folder)bgs/goverMail_111.html"

editable="true" >

" target="_blank">

2.4.3

该标签一般用在标签之间，用来显示内容元素。

比如，这个就是显示XML中的Title元素的值。

2.4.4

使用该标签可以获取XML 内容文件的数量和当前遍历的文件的序号。

其中他有两个值分别为：

contentInfo.resultSize: 返回获取的XML 内容文件的数量

contentInfo.resultIndex: 返回当前遍历的XML 内容文件的序号。

这两个变量一般做分页显示时使用。

2.4.5

该标签用在之间，用来获得当前遍历的XML 内容文件的对象，利用该对象可以灵活的访问其中的元素内容。

使用此标签一定要注意先用contenginf标签的resultSize判断大于0来保证有文件存在，如果只是空文件下是会出错的。比如：

param="%(property.article-folder) bs_consult_%(number).html|BsConsult " editable="true" >

test="${cms:stripHtml(content.value['IsPrivate']) == '公开'}">

test="${cms:stripHtml(content.value['IsPrivate']) == '保密'}">

${contentInfo.resultIndex}

" target="_blank">查看

该信息保密

2.5 例子扩展

2.5.1 扩展说明

a) 点击“投递信件”，页面如下：

b)输入查询码和密码，点击“查询”，页面如下：

c)点击链接，页面如下：

前面说过一个问题，如果点击“信件投递”产生的信件放在哪里呢？在数据库中么？没有！产生的信件不是直接存到数据库，而是存到VFS（就是虚拟文件系统），存在VFS 中的东西就等于opencms会自己帮你存到数据库中，不需要自己来设计信件表之类的。

当然问题又来了，存是存到虚拟文件系统中，那么在虚拟文件系统中又是以一种什么样的方式来存的呢？这又需要用XML来产生一种信件模板。现在我们首先来建立一种信件模板，之后再投递信件，让程序生成一个信件模板发到后台的VFS中。

2.5.2 实现过程

2.5.2.1 建立XML模板

a) 新建一个module,module名字https://www.360docs.net/doc/5f7813321.html,erMail.files

其文件目录如下

其中schemass下面存在一个goverMail.xsd文件，https://www.360docs.net/doc/5f7813321.html,erMail.files下面存在一个workspace.properties文件。

goverMail.xsd就是信件模板的文件

workspace.properties是信件对应的资源文件

< xsd:element >代表一个元素，其中的type属性可指定另外一个类型。比如complexType就是一种复杂类型。

是schema的一种类型，另外还有simpleType简单类型，如果不懂可以随便了解下关于XML的schema规范。

goverMail.xsd的内容如下：

在上面的例子中一个OpenCmsGoverMail类型代表一封信件。

这代表信件的一个元素。

这是指定资源文件的位置

中为特定元素显示挂件，比如Reply元素的类型是opencmsString,而opencmsString 对应的默认挂件是一个输入框。重新制定挂件为HtmlWidget，则是一个类似于textArea的区域。如果不特别指定，都是那类型的默认

Validationrules：代表验证的条件。

b) 建好模板之后要到operatioin-module.xml中加上红色的一段，当然要记得在配置前备份下。

https://www.360docs.net/doc/5f7813321.html,erMail.files

0.1

name="schema">/system/modules/https://www.360docs.net/doc/5f7813321.html,erMail.files/schemas/goverMail.xsd

uri="newresource_xmlcontent.jsp?newresourcetype=GoverMail" order="142" autosetnavigation="false" autosettitle="false" info="https://www.360docs.net/doc/5f7813321.html,erMail"/>

说明：

这句话name代表资源的类型，id代表资源的id号。在前面contentload的param参数中的第二个就是来自这里的name，一定要记住资源的id不能有重复的。

这里的key都是在资源文件中配置的，所以一定要检查存不存在，如果不存在则会报错

这里的order就是资源id号，info也是资源文件中配置的。

c) 在配置好配置文件后要重启tomcat，如果重启的过程中错误，则肯定没有配置正确。

成功启动之后，“新建”->”结构化内容”就能看到如下图所示，其中的政务邮件就是来自key="https://www.360docs.net/doc/5f7813321.html,erMail"

如果出现了想要的类型则正确配置XML的文件，“继续”，在创建的时候如果还是出错则是配置不正确，要么是大小写的问题要么就是资源文件中的key没有！

我新建一个文件test.html

GoverMail代表资源的类型，打开“编辑”如下：

这样代表成功创建了信件的模板。之后就是在投递信件的时候产生这个模板了。

2.5.2.2 程序生成XML模板

新建一个java类GoverMailSvc.java如下：

addGoverMail(Map paramMap)这个方法用来生成模板。其中的参数就是页面传过来的值。getGoverMailSeq()这个方法是获取一个sequence，来作为查询码用的，通过这个方法产生的文件将位于/sites/demo/module_jzyx/下面的某个部门下面。而文件的名字统一都叫做goverMail+查询码.html.

public static final String SITEROOT_JZYX= "/sites/demo/module_jzyx/";

public static String addGoverMail(Map paramMap) throws Exception{ CmsObject cms = getIniCms();

cms.getRequestContext().setSiteRoot(SITEROOT_JZYX);

String queryCode = null;

//获取文件名

Long applySEQ = getGoverMailSeq();

if(applySEQ!=null){

queryCode = String.valueOf(applySEQ);

}else{

queryCode = "999999";

}

String toPerson = new

String(((String)paramMap.get("ToPerson")).getBytes("ISO-8859-1"),"UTF -8");

String filename = "goverMail_"+queryCode+".html";

String resourcePath = toPerson+filename;

cms.createResource(resourcePath, 142);//创建资源，142就是资源id

CmsFile templateFile = cms.readFile(resourcePath);//读取资源

CmsXmlContent template = CmsXmlContentFactory.unmarshal(cms, templateFile);

setAddApplyValue(template,cms,paramMap);//赋值

CmsResource re = cms.readResource(toPerson);

template.getValue("QueryCode",

cms.getRequestContext().getLocale()).setStringValue(cms, queryCode);

Map perMap = (Map)paramMap.get("personMap");

template.getValue("ToPerson",cms.getRequestContext().getLocale()) .setStringValue(cms, "机构："+(String)perMap.get(toPerson));

templateFile.setContents(template.marshal());

cms.writeFile(templateFile);

cms.unlockResource(resourcePath);

return queryCode;

}

private static void setAddApplyValue(CmsXmlContent

template,CmsObject cms,Map paramMap) throws UnsupportedEncodingException {

template.getValue("Name",