niushop单商户V4版插件设计与开发
addon 插件目录) ├─alipay 插件名称 │ ├─ shop shop模块 │ │ ├─controller 控制器 │ │ ├─view 视图 │ │ │ ├─config 配置文件 │ │ ├─diy_view.php 自定义模板配置文件(必存在) │ │ ├─event.php 事件配置文件(必存在) │ │ ├─info.php 插件配置文件(必存在) │ │ ├─menu_shop.php 店铺端菜单配置(必存在) │ │ │ │─data 插件数据 │ │ │ ├─event 相关事件文件(钩子) │ │ ├─Install.php 安装插件执行事件(必存在) │ │ ├─UnInstall.php 卸载插件执行事件(必存在) │ │ ├─Pay.php 对应插件执行事件 │ ├─model 插件逻辑模块 │ ├─icon.png 插件logo
插件开发流程
下面以支付宝支付插件的开发流程进行讲解
- 设计插件名称,例如支付宝支付插件名称alipay.
- 添加插件目录,插件目录在addon文件夹下面,也就是addon/alipay.
- 设计插件logo,插件logo统一命名为icon.png,为统一样式插件logo推荐使用66*66的png图像,将图像放在alipay文件夹下面,也就是addon/alipay/icon.png。
- 创建插件的配置文件,首先创建配置文件夹config,也就是addon/config;其次创建基础配置文件diy_view.php,event.php,info.php,menu_shop.php。下面针对这几个文件的书写做一下说明。
- diy_view.php 模板与链接配置文件,里面有三项配置
- template:模板配置,如果当前插件有自定义的配置页面需要整体化配置可以在这里配置。
- util:自定义组件配置,如果当前插件需要在自定义页面中进行配置展示,可以开发,比如拼团需要在首页显示拼团专区等等。
- link:接设置,如果当前插件需要通过其他页面进行快捷跳转就要注册对应的链接 ,这样配置对应链接就可以显示,例如拼团专区的链接需要其他页面跳转
- 下面是拼团插件的配置:return [ 'template' => [ ], 'util' => [ [ 'name' => 'PINTUAN_LIST', 'title' => '拼团', 'type' => 'OTHER', 'controller' => 'Pintuan', 'value' => '{"sources" : "default", "categoryId" : 0, "goodsCount" : "6", "goodsId": [], "style": 1, "backgroundColor": "", "padding": 10, "list": {"imageUrl": "","title": "拼团专区"}, "listMore": {"imageUrl": "","title": "好友都在拼"}, "titleTextColor": "#000", "defaultTitleTextColor": "#000", "moreTextColor": "#858585", "defaultMoreTextColor": "#858585"}', 'sort' => '10000', 'support_diy_view' => '', 'max_count' => 0 ] ], 'link' => [ [ 'name' => 'PINTUAN', 'title' => '拼团', 'parent' => 'MARKETING_LINK', 'wap_url' => '', 'web_url' => '', 'sort' => 0, 'child_list' => [ [ 'name' => 'PINTUAN_PREFECTURE', 'title' => '拼团专区', 'parent' => '', 'wap_url' => '/promotionpages/pintuan/list/list', 'web_url' => '', 'sort' => 0 ], [ 'name' => 'MY_PINTUAN', 'title' => '我的拼团', 'parent' => '', 'wap_url' => '/promotionpages/pintuan/my_spell/my_spell', 'web_url' => '', 'sort' => 0 ], ] ] ], ]; 注意如果没有配置也要配置相应的空数组return [ 'template' => [ ], 'util' => [ ], 'link' => [ ], ];
- event.php 事件配置文件,监听事件会在系统启动后自动加载,同时存入缓存,系统更新或者安装插件时进行刷新,插件功能有自身内部功能与对外处理或者实现的功能,对内完成的功能可以通过插件本身的菜单或者api接口进行实现,比如拼团,内部功能就行拼团推广,建立团队,创建拼团订单等,实现的功能就是支付之后判断是否成团等等。支付宝支付,内部功能是支付宝支付配置相关,实现的功能就是支付方式展示,支付,支付的同步回调,支付的异步回调。而事件就是实现对应的方法,早期系统命名为钩子。下面说明支付宝支付注册的事件
return [ 'bind' => [ ], 'listen' => [ //支付异步回调 'PayNotify' => [ 'addon\alipay\event\PayNotify' ], //支付方式,后台查询 'PayType' => [ 'addon\alipay\event\PayType' ], //支付,前台应用 'Pay' => [ 'addon\alipay\event\Pay' ], //支付,关闭支付 'PayClose' => [ 'addon\alipay\event\PayClose' ], //支付,原路退款 'PayRefund' => [ 'addon\alipay\event\PayRefund' ], //支付,转账 'PayTransfer' => [ 'addon\alipay\event\PayTransfer' ], //支付,转账方式 'TransferType' => [ 'addon\alipay\event\TransferType' ] ], 'subscribe' => [ ], ];
默认文件书写: return [ 'bind' => [ ], 'listen' => [ ], 'subscribe' => [ ], ];
通过上述配置显示支付宝支付实现了支付回调,支付方式查询,支付方法,支付退款,支付关闭,支付转账功能,这样系统设计人员会针对不同体系的功能设计相应的事件接口,对应的支付插件开发人员只要实现对应的支付事件就可以,不用了解系统内部调用。注意每一个事件的实现都是注册相应的类文件,类文件放在对应插件的event目录,例如支付宝支付实现的类都放在addon/alipay/event。
7. info.php 插件基础配置文件,例如支付宝支付
return [ 'name' => 'alipay', 'title' => '支付宝支付', 'description' => '支付宝支付功能', 'type' => 'system', //插件类型 system :系统插件(自动安装), promotion:营销插件 tool:工具插件 'status' => 1, 'author' => '', 'version' => '1.0.9', 'version_no' => '202007130001', 'content' => '', ];
说明:name代表插件名称与插件目录一致,title代表插件中文名称,description代表插件简介,type代表插件类型,author代表作者,version代表插件版本编码,version_no代表插件序列号,插件升级会按照序列号判断,content代表插件说明