知了CMS开发说明文档(ibeetl) 建站系统文档

约定不等于承诺〃 2023-06-15 13:30 25阅读 0赞

**目录**

知了CMS开发说明文档

一、项目介绍

二、项目结构

三、项目基础

3.1、前台入口控制器类：

3.2、后台入口控制器类：

3.3、项目配置文件

3.4、项目启动与打包

四、相关技术

五、模板标签

5.1、栏目列表标签

5.2、栏目标签

5.3、内容列表标签

5.4、内容列表分页标签（此标签只能在list页面使用）

5.6、友情链接标签

5.7、面包屑导航标签

六、其他

6.1、页面变量

6.2、页面常量

6.3、页面Xss处理

6.4、页面字符串处理

--------------------

# **知了CMS开发说明文档** #

## **一、项目介绍** ##

本项目主要使用springboot、mybatis、beetl开发，支持多站点，无限级栏目，内容模型、模板标签、全文检索、全站静态化等功能。

## **二、项目结构** ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDI5OTAyNw_size_16_color_FFFFFF_t_70][]

## **三、项目基础** ##

### 3.1、前台入口控制器类： ###

前台入口控制器类：**com.zhiliao.module.web.cms.IndexController**

访问路径：[http://127.0.0.1/\{frontPath\}/1][http_127.0.0.1_frontPath_1]

注:  frontPath可在配置文件中配置 默认为front

### 3.2、后台入口控制器类： ###

后台入口控制器类：**com.zhiliao.module.web.system.SystemController**

访问路径：[http://127.0.0.1/\{adminPath\}/l][http_127.0.0.1_frontPath_1]ogin

注: adminPath也可在配置文件中配置 默认为admin

### 3.3、项目配置文件 ###

配置文件中数据库设置什么的比较简单暂且略过，这里说下比较重要的设置，如下图标出的属性必须根据实际访问地址修改。

![20191122183104857.png][]

### 3.4、项目启动与打包 ###

1）启动： SpringBoot已集成嵌入式tomcat，所以开发阶段直接com.zhiliao.CmsApplication类中main的方法即可启动项目。

2）打包： 使用 mvn  clean  package  -Dmaven.test.skip 命令打包，在打war包的时候注意不要将嵌入式tomcat打到war包内，需要添加如下下图参数。

![20191122183111507.png][]

## **四、相关技术** ##

> 1.  SpringBoot
> 2.  Mybatis
> 3.  Mybatis 通用mapper 插件（http://mybatis.tk）
> 4.  Mybatis  pageHelper 分页插件 （http://mybatis.tk）
> 5.  Beetl (http://ibeetl.com)
> 6.  Shiro
> 7.  Ehcache
> 8.  Quartz
> 9.  Druid
> 10. B-jui  v1.2（http://www.b-jui.com/）

## **五、模板标签** ##

注:模板标签实现类全部位于com.zhiliao.component.beetl.tag.cms包下。

### **5.1、栏目列表标签** ###

>    <\#cms\_category\_list  siteId="$\{site.siteId\}" categoryId="0" isNav="1" var="bean">
> 
>          $\{bean.index\}
> 
>          $\{bean.catagoryId\}.....(数据库对应字段)
> 
> </\#cms\_category\_list>

**siteId : 站点编号**

**CategoryId: 栏目编号**

**IsNav：是否导航**

**例子：**

> <**div** **class=****"nav menu"**>  
>     <**ul**>  
>         @if(isNotEmpty(current)&¤t=='index')\{   
>         <**li** **class=****"on"**>  
>         @\}else\{   
>         <**li**>  
>         @\}  
>         <**a** **href=****"$\{baseURL!\}"**>网站首页</**a**>  
>         </**li**>  
>         <\#cms\_category\_list  siteId="$\{site.siteId\}" categoryId="0" isNav="1" var="bean">  
>         @if(isNotEmpty(category)&&(category.categoryId==bean.categoryId||category.parentId==bean.categoryId))\{   
>         <**li** **class=****"on"**>  
>             @\}else\{   
>         <**li**>  
>             @\}  
>             **  
> *            *@if(isNotEmpty(bean.hasChild)&&bean.hasChild)\{   
>             <**a** **href=****"$\{bean.url!\}"**>$\{bean.categoryName!\}</**a**>  
>             <**ul** >  
>                 <\#cms\_category\_list  siteId="$\{site.siteId\}" categoryId="$\{bean.categoryId!\}" isNav="0" var="subBean">  
>                 <**li**>  
>                     <**a** **href=****"$\{subBean.url!\}"**>$\{subBean.categoryName!\}</**a**>  
>                 </**li**>  
>                </\#cms\_category\_list>  
>             </**ul**>  
>             @\}else\{   
>             <**a** **href=****"$\{bean.url!\}"** **target=****"\_blank"**>$\{bean.categoryName!\}</**a**>  
>             @\}  
>         </**li**>  
>         </\#cms\_category\_list>  
>     </**ul**>  
> </**div**>

**效果：**

![20191122183122145.png][]

### **5.2、栏目标签** ###

> <\#cms\_category  categoryId="$\{category.categoryId\}" isParent="1" var="bean">
> 
>  $\{bean.index\}
> 
>      $\{bean.catagoryId\}.....(数据库对应字段)
> 
> </\#cms\_category>

**CategoryId: 栏目编号**

**isParent：是否查询父类（1是，0否）**

**例子:**

> <**div** **class=****"row"**>  
>     <**div** **class=****"n\_content"**>  
>         <**div** **class=****"n\_lf"**>  
>             <\#cms\_category  categoryId="$\{category.categoryId\}" isParent="1" var="bean">  
>             <**div** **class=****"s\_title01"**>  
>                 <**span**>$\{bean.categoryName!,xss\}</**span**>  
>             </**div**>  
>             <**ul** **class=****"n\_lf\_list"**>  
>                 <\#cms\_category\_list  siteId="$\{site.siteId\}" categoryId="$\{bean.categoryId!\}" isNav="0"   var="bean">  
>                 @if(isNotEmpty(category)&&category.categoryId==bean.categoryId)\{   
>                 <**li** **class=****"current"**>  
>                     <**a** **href=****"$\{bean.url!\}"**>$\{bean.categoryName!\}</**a**>  
>                 </**li**>  
>                 @\}else\{   
>                 <**li**>  
>                     <**a** **href=****"$\{bean.url!\}"**>$\{bean.categoryName!\}</**a**>  
>                 </**li**>  
>                 @\}  
>             </\#cms\_category\_list>  
>             </**ul**>  
>         </\#cms\_category>  
>     </**div**>

**效果:**

![20191122183136548.png][]

### **5.3、内容列表标签** ###

> <\#cms\_content\_list  siteId="$\{site.siteId\}" categoryId="213"  orderBy="2" isHot="0"    hasChild="1" isRecommend="0"  size="7"   titleLen="20"   var="bean">
> 
>  $\{bean.index\}
> 
>      $\{bean.catagoryId\}.....(数据库对应字段)
> 
> </\#cms\_content\_list>

**SiteId: 站点编号**

**CategoryId: 栏目编号**

**orderBy：排序类型（0，根据cntentId 倒叙，1根据contentId正序，2发布时间倒序，3发布时间正序，4更新时间倒叙，5更新时间正序）**

**isHot：是否热门（根据浏览量排序）**

**hasChild：包含子栏目内容**

**isRecommend：是否推荐内容（0否，1是）**

**Size：查询的数量**

**titleLen：标题字数长度**

**例子:**

> **   **<**div** **class=****"topic\_items"   ****style=****"****height**:292**px**;**"**>  
>    <**ul**>  
>      <\#cms\_content\_list  siteId="$\{site.siteId\}" categoryId="213"  orderBy="2" isHot="0"    hasChild="1" isRecommend="0"  size="7"   titleLen="20"   var="bean">  
>          <**li**><**a** **HREF=****"$\{bean.url!\}"  ****target=****"\_blank"**>$\{bean.title!,xss\}</**a**><**span**>$\{bean.inputdate,dateFormat="yyyy-MM-dd"\}</**span**></**li**>  
>      </\#cms\_content\_list>   
>    </**ul**>  
> </**div**>

**效果:**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDI5OTAyNw_size_16_color_FFFFFF_t_70 1][]

### **5.4、内容列表分页标签（此标签只能在list页面使用）** ###

> <\#cms\_content\_page  siteId="$\{site.siteId!\}"  titleLen="30" page="$\{page!\}" var="content">
> 
>      $\{bean.index\}
> 
>      $\{bean.title\}
> 
>      $\{bean.catagoryId\}.....(数据库对应字段)
> 
> </\#cms\_content\_page>
> 
>

**siteId:站点编号**

**TitleLen: 标题字数**

**例子:**

> <**div** **class=****"content\_list"**>  
>    <**ul**>  
>            <\#cms\_content\_page  siteId="$\{site.siteId!\}"  titleLen="30" page="$\{page!\}" var="content">  
>                  <**li**>  
>                          <**a** **href=****"$\{content.url!\}"** **target=****"\_blank"**>$\{content.title!,xss\}</**a**>  
>                          @if(isNotEmpty(content.thumb))\{   
>                                   <**span**><**img** **src=****"$\{resPath\}/39z/img/notice\_icon.png"**>（图片）</**span**>  
>                           @\}  
>                            <**time**>$\{content.inputdate!,dateFormat="yyyy-MM-dd"\}</**time**>  
>                   </**li**>  
>            </\#cms\_content\_page>  
>    </**ul**>  
> </**div**>

**效果：**

![20191122183157592.png][]

**5.5、分页标签**

>      <\#cms\_pagination siteId="$\{site.siteId\}" categoryId="$\{category.categoryId\}" page="$\{page\}" moreNum="6"  var="page" >
> 
>      </\#cms\_pagination>

**siteId：站点编号**

**CategoryId: 栏目编号**

**Page：分页对象（使用mybatis pagehelper pageinfo）**

**例子：**

> <**div  ****class=****"m-pagination"**>  
>       <**ul** **class=****"m-pagination-page"** **style=****"****display**: **block**;**"**>  
>          @if(page.pageNum == 1)\{   
>          <**li** **class=****"first"**><**a**>首页</**a**></**li**>  
>          @\}else\{   
>          <**li**><**a** **href=****"$\{ctxPath\}/front/$\{site.siteId\}/$\{category.categoryId\}/index\_1.html"**>首页</**a**></**li**>  
>          @\}  
>          <\#cms\_pagination siteId="$\{site.siteId\}" categoryId="$\{category.categoryId\}" page="$\{page\}" moreNum="6"  var="page" >  
>          <**li**>$\{page.first\}</**li**>  
>   
>          @for( change in page.changePage)\{   
>          @if(!change.isLink)\{   
>          @if(change.isMore)\{   
>          <**li**>$\{change.value!\}</**li**>  
>          @\}else\{   
>          <**li** **class=****"active"**>$\{change.value!\}</**li**>  
>          @\}  
>          @\}else\{   
>          <**li**> $\{change.url!\}</**li**>  
>          @\}  
>          @\}  
>   
>          <**li**>$\{page.next\}</**li**>  
>           </\#cms\_pagination>  
>          @if(page.pageNum == page.pages)\{   
>          <**li**><**a**>末页</**a**></**li**>  
>          @\}else\{   
>          <**li**><**a** **href=****"$\{ctxPath\}/front/$\{site.siteId\}/$\{category.categoryId\}/index\_$\{page.pages!\}.html"**>末页</**a**></**li**>  
>          @\}  
>       </**ul**>  
>       <**div** **class=****"m-pagination-jump"**>  
>          <**div** **class=****"m-pagination-group"**>  
>             <**input** **type=****"number"  ****id=****"pageNum"**><**button** **οnclick=****"***goPageNum*()**"  ****type=****"button"**>Go</**button**>  
>          </**div**>  
>       </**div**>  
>    </**div**>  
> </**div**>

**效果：**

![20191122183207175.png][]

### **5.6、友情链接标签** ###

> <\#cms\_friendlink size="8" groupId="1" var="bean">
> 
>          $\{bean.index\}
> 
> </\#cms\_friendlink>

**     Size:调用数量**

**     groupId：分组编号**

**   例子：**

> <\#cms\_friendlink size="8" groupId="1" var="bean">  
>  @if(bean.index<8)\{   
> <**a** **target=****"\_blank"  ****href=****"$\{bean.linkUrl!\}"**>$\{bean.linkName!\}</**a**> |   
>  @\}else\{   
> <**a** **target=****"\_blank"  ****href=****"$\{bean.linkUrl!\}"**>$\{bean.linkName!\}</**a**>  
>  @\}  
> </\#cms\_friendlink>

**  效果：**

![20191122183213202.png][]

### **5.7、面包屑导航标签** ###

>    <\#cms\_site\_pos  site="$\{site\}" category="$\{category\}"  var="bean">    
>     </\#cms\_site\_pos>

**   Site：site对象（index，list，content页面均可获取）**

**   Category:(content页面均可获取DAO )**

**  例子:**

> <**label** **class=****"content\_bread"**>  
>    <**img** **src=****"$\{resPath\}/3****Z****/img/pos.png"**/>  
>                       <\#cms\_site\_pos  site="$\{site\}" category="$\{category\}"  var="bean">  
>                           <**span**>您当前的位置：$\{bean.baseURL\}</**span**>  
>                           <**span**>></**span**>  
>                           @for(location in bean.locations)\{   
>                           <**a** **href=****"$\{location.url\}"**>$\{location.categoryName\}</**a**>  
>                           @if(!locationLP.last)\{   
>                           <**span**>></**span**>  
>                           @\}  
>                           @\}  
>                       </\#cms\_site\_pos>  
> </**label**>

**效果：**

![20191122183223370.png][]

**5.8、模型字段查找标签（支持自定义模型为radio的字段）**

>  <\#cms\_modelfiled\_find siteId="$\{site.siteId!\}"   categoryId="$\{category.categoryId!\}" modelId="80" filedName="riqi" param="$\{param!\}"  var="filed">
> 
>  
> 
> </\#cms\_modelfiled\_find>

**siteId：站点编号**

**categoryId：栏目编号**

**modelId：模型编号**

**filedName：字段名称**

**Param：查询参数**

**例子**

> <**label** **class=****"select"**>  
>    日期 ：  
>    <**select  ****id=****"rqi"**>  
>       <**option** **VALUE=****""**>请选择</**option**>  
>       <\#cms\_modelfiled\_find siteId="$\{site.siteId!\}"   categoryId="$\{category.categoryId!\}" modelId="80" filedName="riqi" param="$\{param!\}"  var="filed">  
>       @if(isNotEmpty(param))\{   
>       @var sekected = '';  
>       @if(isNotEmpty(session.riqi)&&session.riqi==filed.name)\{   
>       @sekected = 'selected="selected"';  
>       @\}  
>       <**option** **value=****"$\{filed.url!\}"** **$\{sekected\}** >$\{filed.name!\}</**option**>  
>       @\}else\{   
>       <**option** **value=****"$\{filed.url!\}"** >$\{filed.name!\}</**option**>  
>       @\}  
>    </\#cms\_modelfiled\_find>  
>    </**select**>  
> </**label**>

**效果：**

![20191122183231555.png][]

## **六、其他** ##

### **6.1、页面变量** ###

>   ** site ：当前站点对象（可在index,list,content页面获取到）**
> 
> **   category ：当前栏目对象（可在list,content页面获取到）**
> 
> **   content ：当前栏目对象（可在list,content页面获取到）**
> 
> **   description: 页面描述（可在index,list,content页面获取到）**
> 
> **   Keywords：页面关键字（可在index,list,content页面获取到）**

### **6.2、页面常量** ###

com.zhiliao.component.beetl.BeetlConfiguration

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDI5OTAyNw_size_16_color_FFFFFF_t_70 2][]

### **6.3、页面Xss处理** ###

>    $\{bean.title!,xss\}

### **6.4、页面字符串处理   ** ###

>    日期格式化：$\{content.inputdate!,dateFormat="yyyy-MM-dd"\}
> 
>     字符串处理：http://ibeetl.com/guide/\#beetl

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDI5OTAyNw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191122183056177.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDI5OTAyNw==,size_16,color_FFFFFF,t_70
[http_127.0.0.1_frontPath_1]: http://127.0.0.1/%7BfrontPath%7D/1
[20191122183104857.png]: https://img-blog.csdnimg.cn/20191122183104857.png
[20191122183111507.png]: https://img-blog.csdnimg.cn/20191122183111507.png
[20191122183122145.png]: https://img-blog.csdnimg.cn/20191122183122145.png
[20191122183136548.png]: https://img-blog.csdnimg.cn/20191122183136548.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDI5OTAyNw_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191122183149345.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDI5OTAyNw==,size_16,color_FFFFFF,t_70
[20191122183157592.png]: https://img-blog.csdnimg.cn/20191122183157592.png
[20191122183207175.png]: https://img-blog.csdnimg.cn/20191122183207175.png
[20191122183213202.png]: https://img-blog.csdnimg.cn/20191122183213202.png
[20191122183223370.png]: https://img-blog.csdnimg.cn/20191122183223370.png
[20191122183231555.png]: https://img-blog.csdnimg.cn/20191122183231555.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDI5OTAyNw_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191122183241349.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDI5OTAyNw==,size_16,color_FFFFFF,t_70