1. 评论插件手册
低代码开发评论插件,可以快速对文章、商品或其他数据进行评论。
评论插件是一个通用插件,开发者可以尽情扩展增加属于自己的业务。
[!tip] 通过
dataType
区分是文章、商品,例如:dataType=文章
,dataType=商品
2. 依赖
<dependency>
<groupId>net.mingsoft</groupId>
<artifactId>ms-mcomment</artifactId>
<version>当前版本</version>
</dependency>
[!tip] 安装会员插件可以直接体验默认效果
3. 接口
3.1. 前端接口
http://localhost:8080/people/comment/*.do(会员层)
http://localhost:8080/comment/*.do(web层)
3.1.1. 会员模式(默认提供的演示业务,需要会员插件)
- 后台在评论配置中开启评论
- 制作的皮肤 保存评论 的函数需调用会员层的接口
- 会员层接口必须登陆才能访问
3.1.2. 游客模式 (不推荐使用)
- 后台在评论配置中开启评论并且开启游客模式
- 制作的皮肤 保存评论 的函数需调用web层的接口
- 游客无需登陆,但需要校验验证码
[!tip] 我们不推荐使用游客模式,如果想要开启,建议根据登陆状态在前端判断调用哪个接口,并且让后端人员在web层接口根据ip等信息对评论进行一定限制。
3.1.3. 前端参数
评论携带附件资源(图片、视频)需要传递json数据
查看接口参数规范: http://localhost:8080/swagger-ui.html#/前端-用户-会员模块接口
评论验证码:如果皮肤调用的是web接口,则需进行验证码的校验 下面是action.web.commentAction save方法的代码片段
// 是否开启验证码
if (!this.checkRandCode("rand_code")) {
return ResultData.build().error( getResString("err.error", this.getResString("rand.code")));
}
评论审核:后台在评论配置中开启评论审核,则所有评论需要通过审核才显示在页面上
3.2. 后端接口
为保证评论插件的高可用,以及简化二开成本,一些重复性、必要的参数校验在业务层做了校验
以会员的保存评论为例:
开发者如果是对接自己的业务系统,可以直接新建一个action,在action里添加自己的业务逻辑,调用通用的业务层方法即可。
[!tip] 在二开时,注意修改action中的业务代码,业务层的保存是通用的。
4. 版本更新说明
每天都在改变、从未停止过....