标签使用说明
- 前言
本系统所使用的标签延续freemarker标签或基于freemarker标签自定的标签,如下分别对原有标签及自定义标签进行说明。如有未说明事项都延续freemarker自身用法。
freemarker模板使用说明
- 标签使用说明
1、freemarker自带支持多种标签开始符号和结束符号,如<> 、[]等。本文档推荐使用 [],后续文档教程中默认使用[],不作特殊说明
2、自定义标签返回结果可能为对象、集合等,为了更好的区分与识别返回结果类型,自定义开发时做了特殊的返回key对应,同时也要求在是用模板获取自定义标签数据时,需要用对应标签的key。系统已支持的的所有自定义标签默认为(具体如何辨别,详见各标签中的返回对象类型,如需要更改,请参考 自定义标签开发教程中第三点特殊说明):
对象(Object): tag_bean
集合(Array) : tag_list
分页对象 : tag_pagination
3、自定义标签区别于freemarker自带标签的使用的在于将 # 替换成 @,如 [@position_page];各标签支持参数请参标签说明
注意:在同一模板中不能同时使用多种开始和结束符号
获取公共数据
| 参数 |
类型 |
示例值 |
说明 |
| base |
string |
jspgou |
商城根目录,带目录部署的系统则返回 “网站根目录”,反之为 “” |
| resSys |
string |
/r/gou |
静态资源文件目录,如css js image等,默认已拼接了上述base参数,调用者无需手动拼接base参数 |
| 参数 |
类型 |
示例值 |
说明 |
| › globalConfig |
Object |
|
商城系统配置 |
| - mallName |
string |
1 |
商城名称 |
| - title |
string |
上JSPGOU,一次就“购”了 |
商城标题 |
| - description |
string |
JSPGOU商城 |
商城描述 |
| - keywords |
string |
jspgou,商城,b2b2c |
商城关键词 |
| - customerServiceMobile |
string |
0791-86538070 |
客服电话 |
| - customerServiceEmail |
string |
|
客服邮箱 |
| - copyright |
string |
ICP备案号:赣ICP备18000538号-1 |
版权信息 |
| - address |
string |
南昌市西湖区沿江大道1299号力高滨江国际天郡A座503 |
商城地址 |
| - areaCode |
string |
310000 |
商城显示地区编码 |
| - areaName |
string |
江西 |
商城显示地区名称 |
| - areaDistrict |
string |
|
商城显示地区(区) |
| - areaCity |
string |
|
商城显示地区(市) |
| -› searchKeyWords |
array |
|
商城搜索关键词数组 |
| - - 0 |
string |
手机 |
商城搜索关键词 |
| - - 1 |
string |
apple |
商城搜索关键词 |
| - hotWords |
string |
apple |
商城搜索热词 |
| - categoryNavLayoutModel |
number |
1 |
首页分类导航布局模式 1- 仅显示一级分类 2-显示一级分类及分类导航设置关联分类 |
| - tplPcSolution |
string |
default |
指定PC模板 |
| - tplMobileSolution |
string |
mobile |
指定WAP模板 |
| - tplPadSolution |
string |
pad |
指定平板模板 |
| - mallLogo |
string |
/u/201803/32dferdfjqie.png |
商城logo |
| - mallLoginAndRegLogo |
string |
/u/201803/32dferdfjqie.png |
商城注册登录页log |
| - userRegisterAgreement |
string |
协议内容 |
用户注册协议 |
| - storeRegisterAgreement |
string |
协议内容 |
商家入驻协议 |
| - isOpenSMS |
boolean |
true |
系统短信开启状态true表示是,false表示否 |
| - userScoreMinAmount |
number |
100 |
系统设置积分最低使用金额限制 |
| - userRhMinAmount |
number |
100 |
系统设置红包最低使用金额限制 |
| - memberRegistGrowth |
number |
100 |
新用户注册增送经验值 |
| - irstLoginPerdayGiftExp |
number |
100 |
用户每日登入赠送经验值 |
| - shoppedGiftExtRatio |
number |
100 |
进行一次购物,以有效订单购买金额为标准,按比例计算赠送经验值 |
| - singleOrderMaxGiftExp |
number |
100 |
单笔订单最多可赠送经验值 |
| - orderCommentGiftExp |
number |
100 |
进行一次订单评价,可活动经验值 |
| - > area |
array |
|
全国行政区域信息 |
| - - areaCode |
string |
100 |
区域编号 |
| - - areaName |
string |
100 |
区域名称 |
| - - areaDictCode |
string |
100 |
区域类型(字典code,1省,2市,3区) |
| - - childs |
array |
|
下级行政区域信息(重复当前对象数据,支持无限层级展示) |
| - wechatQRcodeUrl |
string |
100 |
微信公众号图片 |
| - miniprogramQRcodeUrl |
string |
100 |
微信小程序图片 |
| - orderAutoReceiveTime |
number |
5 |
订单自动确认收货时效(天) |
| - orderReturGoodsMaxTime |
string |
5 |
订单退货时效(天) |
| - orderCloseHour |
number |
24 |
订单自动关闭时效(小时) |
| - orderExtendReceiveTime |
number |
3 |
延长订单收货时长(天) |
| - orderRefundSellerCheckDay |
number |
3 |
售后等待卖家审核时效(天) |
| - orderRefundMemberShipDay |
number |
3 |
售后等待买家发货任务时效(天) |
| - orderRefundSellerReceiveDay |
number |
7 |
售后等待卖家收货任务时效(天) |
| - orderRefundSellerShipDay |
number |
3 |
售后等待卖家发货任务时效(天) |
| - orderRefundMemberReceiveDay |
number |
7 |
售后等待买家收货任务时效(天) |
| 参数 |
类型 |
示例值 |
说明 |
| › user |
Object |
|
当前登录用户信息 |
| - id |
number |
1 |
会员id |
| - nickname |
string |
soul |
昵称 |
| - name |
string |
张三 |
姓名 |
| - username |
string |
soul |
会员账户,可用于登录,无法修改 |
| - email |
string |
1541631@qq.com |
邮箱,可用于登录 |
| - phone |
string |
15215231111 |
手机号,可用于登录 |
| - gender |
number |
1 |
性别 1 男 2 女 3 保密 |
| - birthday |
string |
2000-01-01 |
生日 |
| - enabled |
boolean |
true |
是否启用 否-false 是-true |
| - headImgUrl |
string |
/u/201803/32dferdfjqie.png |
会员头像url |
| - headImgId |
number |
2 |
头像图片资源id |
| - balance |
number |
0 |
余额(单位:元) |
| - score |
number |
0 |
积分 |
| - exp |
number |
50 |
成长值 |
| - redEnvelope |
number |
0 |
账户持有红包 |
| - levelName |
string |
vip1 |
会员等级名称 |
| - levelImageUrl |
string |
/u/201803/32dferdfjqie.png |
会员等级图片url |
| - isSetPayPassword |
boolean |
true |
当前用户是否设置支付密码 |
| - isOpenStore |
boolean |
true |
是否开通店铺.true表示已开通,false表示未开通 |
<!Doctype html><html><head><title>${globalConfig.mallName!}</title><meta http-equiv="keywords" content="${globalConfig.keywords!}"/><meta http-equiv="description" content="${globalConfig.description!}"/></head><body><!--模板获取商城系统配置信息数据示例--></body></html>
示例中 “!” 符号的使用标识防止属性为空抛异常
<!Doctype html><html><head><title>${globalConfig.mallName!}</title><meta http-equiv="keywords" content="${globalConfig.keywords!}"/><meta http-equiv="description" content="${globalConfig.description!}"/><link type="text/css" rel="stylesheet" href="${resSys}/css/index.css" /></head><body> <!--模板获取登录用户信息示例--> [#if user??] 用户已登录 昵称:${user.nickname} 姓名:${user.name} 姓名头像:<image src="${headImgUrl}"/> [#else] 用户未登录 [/#if]</body></html>
店铺头部
[@store_head]
| 参数 |
类型 |
必填 |
示例值 |
说明 |
| storeId |
number |
是 |
414 |
店铺ID |
| 参数 |
类型 |
示例值 |
说明 |
| - collections |
number |
5 |
店铺粉丝数 |
| - companyName |
string |
金磊科技 |
公司名称,店铺为企业返回是”企业名称”,店铺为个人店铺是返回”个人” |
| - expressContrast |
string |
0 |
商家发货速度与行业对比值 |
| - expressState |
number |
2 |
商家发货速度类型:1-高于,2-持平,3-低于 |
| - matchVContrast |
string |
0 |
商品符合度与行业对比值 |
| - matchVState |
number |
2 |
商品符合度类型:1-高于,2-持平,3-低于 |
| › navigations |
Array |
|
导航栏商品分类 |
| - - cateName |
string |
新品 |
分类名称 |
| - - description |
string |
|
分类页描述 |
| - - id |
number |
112 |
分类id |
| - - keywords |
string |
|
分类页关键词 |
| › productCategories |
Array |
|
该店铺总商品分类 |
| - - cateName |
string |
大衣 |
分类名称 |
| - - description |
string |
大衣 |
分类页描述 |
| - - id |
number |
162 |
分类id |
| - - keywords |
string |
大衣 |
分类页关键词 |
| -› childs |
Object |
|
此商品分类的子分类集合 |
| - - - cateName |
string |
貂皮 |
分类名称 |
| - - - description |
string |
貂皮 |
分类页描述 |
| - - - id |
number |
172 |
分类id |
| - - - keywords |
string |
貂皮 |
分类页关键词 |
| - - - parentId |
number |
162 |
父类id |
| - - parentId |
number |
|
父类id |
| - selfShop |
boolean |
true |
是否自营店铺 |
| - serviceContrast |
string |
0 |
商家服务态度与行业比对值 |
| - serviceState |
number |
2 |
商家服务态度类型:1-高于,2-持平,3-低于 |
| › storeHeadImgResource |
Object |
|
店铺头像资源数据对象 |
| - - url |
string |
/u/gou/www/201807/241616283yqx.jpg |
图片url |
| › storeLogoResource |
Object |
|
店铺login资源实体类 |
| - - url |
string |
/u/gou/www/201807/241616283yqx.jpg |
图片url |
| - storeName |
string |
黄小强数码专营店 |
店铺名称 |
| › storeSet |
Object |
|
店铺设置实体类 |
| - - description |
string |
小店铺 |
店铺描述 |
| - > resourcesSpaceData |
Object |
|
店铺首页横幅资源对象 |
| - - - url |
string |
/u/gou/www/201807/241616283yqx.jpg |
图片url |
| - - themeColor |
string |
#666666 |
店铺主题色 |
| › storeStatistics |
Object |
|
商家评分实体类 |
| - - express |
number |
2 |
商家发货速度 |
| - - id |
number |
414 |
店铺id |
| - - matchV |
number |
3 |
商品符合度 |
| - - service |
number |
3 |
商家服务态度 |
[@store_head storeId="414"] <pre data-v-cfff44c0=""> <table> <tr>${tag_bean.expressContrast!}</tr> <tr>${tag_bean.expressState!}</tr> <tr>${tag_bean.matchVContrast!}</tr> </table> </pre> [/@store_head]
首页导航
[@index_navi]
| 参数 |
类型 |
必填 |
示例值 |
说明 |
| clientType |
string |
是 |
wap |
终端类型,可选值(pc,wap,miniprogram) |
| count |
int |
是 |
1 |
页面容量 |
|参数|类型|示例值|说明|
数据结构类型:object
| 参数 |
类型 |
示例值 |
说明 |
| alias |
string |
造假 |
别名 |
| id |
number |
2 |
导航id |
| logoResId |
number |
1655 |
关联图标id |
| › logoResource |
object |
关联图标 |
| - id |
number |
1655 |
关联图标id |
| - resourceType |
number |
1 |
图标文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他) |
| - url |
string |
/u/gou/www/201810/311227088zrx.jpg |
资源URL |
| proCategoryId |
number |
102 |
关联商品分类id |
| › productCategory |
object |
|
关联商品分类 |
| - cateName |
string |
手机通讯 |
商品分类名称 |
| - id |
number |
102 |
- |
| sortNum |
number |
10 |
排序值 |