标签使用说明

- 前言
本系统所使用的标签延续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表示未开通
  1. <!Doctype html>
  2. <html>
  3. <head>
  4. <title>${globalConfig.mallName!}</title>
  5. <meta http-equiv="keywords" content="${globalConfig.keywords!}"/>
  6. <meta http-equiv="description" content="${globalConfig.description!}"/>
  7. </head>
  8. <body>
  9. <!--模板获取商城系统配置信息数据示例-->
  10. </body>
  11. </html>

示例中 “!” 符号的使用标识防止属性为空抛异常

  1. <!Doctype html>
  2. <html>
  3. <head>
  4. <title>${globalConfig.mallName!}</title>
  5. <meta http-equiv="keywords" content="${globalConfig.keywords!}"/>
  6. <meta http-equiv="description" content="${globalConfig.description!}"/>
  7. <link type="text/css" rel="stylesheet" href="${resSys}/css/index.css" />
  8. </head>
  9. <body>
  10. <!--模板获取登录用户信息示例-->
  11. [#if user??]
  12. 用户已登录
  13. 昵称:${user.nickname}
  14. 姓名:${user.name}
  15. 姓名头像:<image src="${headImgUrl}"/>
  16. [#else]
  17. 用户未登录
  18. [/#if]
  19. </body>
  20. </html>

自定义标签开发教程

商品规格列表

[@proTypeAttr_page]

参数 类型 必填 示例值 说明
proCategoryId number 1 商品分类id
参数 类型 示例值 说明
proCategory object 商品分类
- cateName string 电子数码 商品分类名称
- id number 92 商品分类id
- isChild boolean - 是否为子节点,true表示是
- nodeIds object 节点列表ID。从父节点到自身。
- parent object 父节点
brands object 品牌数据
- enName string ofo 英文名字
- id number 61 品牌id
- name string ofo 品牌名称
- resourcesSpaceData object 图片资源
- - resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- - url string /u/gou/www/201809/0715541641bj.jpg 资源路径
- url string - 网址
attrs object 规格数据
- attrValueList object 类型(规格)属性值
- - attrCode string 89928275 规格属性值编号
- - attrValue string 深空灰 规格属性值
- - id number 372 规格属性值id
- id number 212 规格属性id
- name string 颜色 规格属性名称
- valueType number 4 属性值类型(1文本,2单选,3多选,4图片(单选))

获取推荐商品

[@proRecommend_page]

参数 类型 必填 示例值 说明
resultSize number 15 商品结果数据长度
参数 类型 示例值 说明
coverImage string /u/gou/www/201809/28190803gcyp.jpg 商品主图地址
id number 542 商品id
name string 华硕1080ti吃鸡显卡 商品名称
salePrice number 3599 商品销售价格
storeId number 414 店铺id

商品详情信息

[@product_page]

参数 类型 必填 示例值 说明
proId number 1 商品ID
参数 类型 示例值 说明
promotes object 商品活动
- conOrderAmount number 1 活动条件-订单金额
- conProductNum number 2 活动条件-商品数量
- conType number 1 活动条件-类型(1 满多少 2 每满多少 3第几件)
- discountAmount number 1 活动优惠金额
- discountMode number 6 活动优惠类型(1订单满减 2订单赠品 3订单赠优惠券 4包邮 5支付减 6单品优惠)
- flagIcon object 活动图标
- id number 743 商品活动id
- name string 满1499减1498优惠券 名称
- promoteBeginTime number 1541088000000 活动开始时间
- promoteEndTime number 1543507200000 活动结束时间
- promoteType number 4 活动类型(1 单品折扣 2 单品一口价 3 满减 4 优惠券 5满赠 6包邮)
- remark string 满1499减1498 活动备注
combons object 商品组合
- combonId number 1151 商品组合id
- combonName string vivo Z1 新一代全面屏 双摄拍照手机 移动联通电信4G全网通 6GB+64GB大内存智能手机 极光特别版 组合商品名称
- combonResource object 组合商品图片,视频资源
- - imageResouce object 图片空间资源
- - - resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- - - url string /u/gou/www/201810/31122711wucp.jpg 图片路径
- - isCover boolean true 是否为主图 true是 false否
- - videoResource object 视频路径,引用图片空间资源
- combonSalePrice number 1598 组合商品售价
- id number 1 组合id
hasSkuAttr boolean true 是否存在规格属性,true表示已存在
imgResources object 商品图片
- imageResouce object 图片空间资源
- - resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- - url string /u/gou/www/201810/31122711wx8a.jpg 图片路径
- isCover boolean true 是否为主图 true是 false否
- videoResource object 视频空间资源
proConsumerServices object 商品保障服务
- description string 退货无忧 服务描述
- resourcesUrl string /u/gou/www/201809/19095937yomm.png 图片资源路径
- serviceName string 退货无忧 服务名称
proStatistic object 商品销量统计
- totalCollections number - 商品总收藏量(人气)
- totalComment number - 商品总评论量
- totalSales number - 商品总销量
proStatus number 1 商品状态. 1:已发布 2:已下架3:已删除
product object 商品信息
- category object 商品分类
- - cateName string 手机 商品分类名称
- - id number 132 商品分类id
- - isChild boolean true 是否为子节点,true表示是,false表示否
- - nodeIds object 节点列表ID。从父节点到自身。
- - parent object 父节点
- - - cateName string 电子数码 商品分类名称
- - - id number 92 -
- - - isChild boolean - -
- - - nodeIds object -
- - - parent object -
- categoryId number 132 商品分类id
- id number 1152 商品id
- inventory number 1000 总库存量
- summaryColor number 1000 商品简介显示颜色值
- storeId number 414 店铺id
- marketPrice number 3399 市场价
- name string 华为 HUAWEI Mate 10 4GB+64GB 亮黑色 移动联通电信4G手机 双卡双待 商品名称(标题显示的名称)。
- salePrice number 0.01 销售价
- status number 3 -
- summary string 商品简介 商品简介
skuAttrs object 商品Sku属性
- attrName string 颜色 规格名称
- attrs object 规格名称对应的商品各个规格值
- - attrName string 颜色 属性名称
- - attrValueCode string 14409364 属性值编号
- - attrValueName string 白色 属性值
- - productTypeId number 112 商品类型Id
- - resourceData object 资源空间
- - - resourceType number 1 资源类型
- - - url string /u/gou/www/201810/31122711wx8a.jpg 资源路径
skus object 商品Sku
- id number 822 skuId
- inventory number 5 库存
- saleAttrCode string 10695519-14409364-27910291 关联的规格code数据,存储值:value1,value2,value3
- salesPrice number 0.02 售价
- skuNumber string 59248914118152 sku编号
- warning number 1 商品内容详情
txt object 预警值
- bottomTpl object 关联底部样式
- mobileTxt string - 手机端商品详情
- pcTxt string

商品详细内容

PC端商品详情
- topTpl object 关联顶部样式
videoResources object 视频资源

商品分类列表

[@proCategory_page]

参数 类型 必填 示例值 说明
parentId number 1 父节点ID
参数 类型 示例值 说明
advertisingOne object 广告图1
- resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- url string /u/gou/www/201809/07092924sn9s.jpg 图片路径
advertisingTwo object 广告图2
- resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- url string /u/gou/www/201809/07092924j3rh.jpg 图片路径
brandSet object 推荐品牌
cateName string 电子数码 商品分类名称
id number 92 商品分类id
nameAlias string - 分类别名
productTypeId number 102 商品类型id
resourcesSpace object 分类图标路径
sortNum number 1 排序值
subCateSet object 推荐分类
- cateName string 手机 商品分类名称
- id number 103 商品分类id
- nameAlias string - 分类别名
- productTypeId number 112 商品类型id
- resourcesSpace object -
- sortNum number 10 排序值
topCateSet object 推荐顶级分类导航
- cateName string 手机配件 分类名称
- id number 104 分类id
- nameAlias string - 分类别名
- productTypeId number 113 关联的商品类型id
- resourcesSpace object 分类图标路径
- sortNum number 1 排序值

首页楼层分页

[@indexLayout_page]

参数 类型 必填 示例值 说明
pageNo number 1 当前页码
count number 1 页面容量
参数 类型 示例值 说明
content object -
- indexLayout object 首页设置
- - adId number 5 广告ID
- - advertisement object 关联广告
- - - adPositionId number 1 广告版位id
- - - articleCateId object 文章类型id
- - - articleId object 文章id
- - - id number 24 广告id
- - - isShow boolean true 是否显示
- - - isTarget boolean true 是否打开新窗口 0- 否 1-是
- - - linkType number 2 链接类型 1-商品 2-店铺 3- 文章 4-商品分类 5-固定url
- - - linkUrl string - 固定url
- - - pictureId number 95 图片ID
- - - productCateId number 112 商品分类id
- - - productId number 542 商品id
- - - resourcesSpaceData object 资源数据对象
- - - - id number 95 资源id
- - - - resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- - - - url string /u/gou/www/201807/241616287hpj.jpg 图片路径
- - - title string 大甩卖 广告标题
- - categoryData string [{“cate_name”:”电子数码”,”cate_id”:191},{“cate_name”:”手机”,”cate_id”:190},{“cate_name”:”99纯银”,”cate_id”:189},{“cate_name”:”水晶手链”,”cate_id”:188},{“cate_name”:”戒指”,”cate_id”:187},{“cate_name”:”手链”,”cate_id”:186}] 推荐分类数据,JSON字符串 [{cate_name:’分类名’ , cate_id:’分类ID’}]
- - floorName string 手机数码 楼层名称
- - id number 32 首页设置id
- - isShow boolean true 是否显示 0-否 1-是
- - layoutType number 1 布局模式 1-窄体布局 2-宽体布局
- - remark string - 备注
- - subtitle string Mobile Digital 副标题
- - themeColor string #FFFFFF 主题色
- panelTitles object 楼层拌面标题数组
- - 0 string -
- - 1 string -
- - 2 string -
- - 3 string -
- penelLayoutVOs object 楼层拌面ViewModel
- - advertisements object 广告集合
- - - id number 1 广告id
- - - linkUrl string - 固定url
- - - title string 2元促销 广告标题
- - - resourcesSpaceData object 资源数据对象
- - - - id number 93 资源id
- - - - resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- - - - url string /u/gou/www/201807/241616283yqx.jpg 图片路径
- - brandIds string 45,46,47,48,49 品牌id集合
- - brands object 品牌集合
- - - id number 45 品牌id
- - - name string 华硕 品牌名称
- - - resourcesSpaceData object 资源数据对象
- - - - id number 559 资源数据id
- - - - resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- - - - url string /u/gou/www/201809/03192815xo8f.jpg 图片路径
- - - url string - 网址
- - id number 33 楼层拌面id
- - layoutType number 1 布局模式 1-商品-广告混合模式 2-商品列表模式
- - products object 商品集数据
- - - product object 商品信息
- - - - id number 572 商品id
- - - - salePrice number 572 销售价
- - - - name string GTX1080Ti显卡 商品名称(标题显示的名称)。
- - - showImageUrl string /u/gou/www/201809/28163912leqp.jpg 显示的图片路径
- - sortNum number 1 排序值
- - title string 排行榜 标题
first boolean true -
last boolean true -
size number 5 -
totalElements number 1 -
totalPages number 1 -

广告版位

[@position_page]

参数 类型 必填 示例值 说明
positionCode string index 广告标识
参数 类型 示例值 说明
adPosition Object 广告版位对象
- id number 1 版位ID
- positionName string 电子数码 版位名称
-›sysAds Array 广告列表集合
- - id number 1 广告列表Id
- - title string 精品热卖 广告标题
- - isTarget boolean 1 是否打开新窗口 0- 否 1-是
- - pictureId number 1 图片ID
- - productId number 1 商品ID
- - storeId number 1 店铺ID
- - articleId number 1 文章id
- - productCateId number 1 商品分类id
- - linkType number 1 链接类型 1-商品 2-店铺 3- 文章 4-商品分类 5-固定url
- - linkUrl string 1 固定url
- -> resourcesSpaceData Object 1 资源对象
- - - id number 1 资源对象ID
- - - url string 1 图片路径
- - - resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- - - size number 1 资源大小
- - - ownerType number 1 资源所属平台:1.平台,2.店铺,3.前台会员

页面底部

[@bottom_page]

参数 类型 示例值 说明
articleCategorys Array 文章分类集合
- id number 1 文章分类ID
- name string 电子数码 文章分类名称
-› articles Array 文章集合
- - id number 文章id
- - title string 文章标题
consumerServices Array 消费者保障服务集合
- id number 1 服务ID
- serviceName string 包邮 名称
- description string 全部包邮 服务描述

品牌标签

[@brand_page]

参数 类型 必填 示例值 说明
categoryId number 1 商品分类ID
pageNo number 1 页数
count number 1 数量
参数 类型 示例值 说明
content Object 品牌数据对象
- id number 10 品牌ID
- name string 华硕 品牌名称
- profile string 品牌简介
- enName string 华硕 英文名字
- initials string H 首字母
- url string www.1321.com 网址
- logo number 1 logo图路径,引用图片空间资源id
- sortNum number 1 排序值
- > resourcesSpaceData Object 1 资源对象
- - id number 1 资源对象ID
- - url string 1 图片路径
- - resourceType number 1 文件类型(1图片 2视频 3音频 4word 5excel 6ppt 7压缩包 8其他)
- - size number 1 资源大小
- - ownerType number 1 资源所属平台:1.平台,2.店铺,3.前台会员

举报商品信息

[@product_report_page]

参数 类型 必填 示例值 说明
proId number 1 商品ID
参数 类型 示例值 说明
product object 商品信息
- brand object 品牌信息
- - enName string asus 品牌英文名称
- - id number 45 品牌id
- - name string 华硕 品牌名称
- category object 商品分类
- - cateName string 显卡 分类名称
- - childs object 子节点集合
- - id number 112 分类id
- - nodeIds object 从父节点到自身id列表
- - parentId number 108 父节点id
- coverImage string /u/gou/www/201809/28190803gcyp.jpg 商品主图
- id number 542 商品id
- itemCode string 1538115264984600 商品信息的唯一编码。本字段是从业务角度考虑的,相当于全局的唯一业务主键。
- name string 华硕1080ti吃鸡显卡 商品名称
- store object 店铺
- - id number 414 店铺id
- - storeName string 黄小强数码专营店 店铺名称
- summary string 华硕新品 商品简介

店铺头部

[@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 商家服务态度
  1. [@store_head storeId="414"]
  2. <pre data-v-cfff44c0="">
  3. <table>
  4. <tr>${tag_bean.expressContrast!}</tr>
  5. <tr>${tag_bean.expressState!}</tr>
  6. <tr>${tag_bean.matchVContrast!}</tr>
  7. </table>
  8. </pre>
  9. [/@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 排序值