Phone: 158 4018 8888 Email: 407593529@qq.com

插件开发规范

2026-02-28 10:34:44 18

插件开发规范

命名规范

java 后端命名规范

结构类型 命名规范与实例 作用
控制器(controller) 首字母大写,驼峰命名,按照不同端口分(adminapi,api)。例:ConfigController api接口访问
实体类(entity) 与数据表一致,首字母大写,驼峰,数据表按照首字母小写,多个单词使用下划线,例:GoodsCategory 与数据库对应,实现数据的增删改查
mapper视图(mapper) 与数据表一致,首字母大写,驼峰,例:GoodsCategoryMapper 数据视图
service服务层(service) 接口命名:I+主题+Service,例如IGoodsService。接口实现:主题+ServiceImpl。注意分端口admin为adminapi接口服务,api为api接口服务,core为其他服务层实现,一般用作公共逻辑 实现逻辑服务,以及为接口实现相关逻辑
enums枚举类(enums) 主题+Enum,例如:MemberActionEnum 系统业务中固定的数据,比如订单状态,操作类型,订单类型,会员账户类型等
请求参数(param) 参数请求与业务层放在一起,文件夹命名param,类名:主题+Param。例如:GoodsParam,AddonSearchParam 接口请求参数,包括数据接收,验证等作用
视图(vo) 视图与业务层放在一起,文件夹命名vo,类型:主题+Vo。例如:ShopGoodsVo,MemberListVo 接口数据,为其他业务逻辑提供相应数据结构。
事件定义(event) 对应行为主题+Event,例如:OrderPayAfterEvent,AddSiteEvent 实现行为定义扩展解耦,例如,OrderPayAfterEvent,定义了订单订单完成后需要执行的事件类,相应的业务去实现事件监听,比如订单支付后结算,分账,计算佣金等
事件监听(listener) 对应监听事件+Listener,例如OrderPayAfterListener 监听行为扩展解耦,例如,OrderPayAfterListener,订单支付完成后会调用事件,这里就可以实现相应的订单支付后的业务
计划任务(job) 文件夹命名job,对应任务类:任务主题+Job,例如:SiteExpireJob 定时任务,例如站点到期关闭,活动定时开启,关闭等

admin 前端以及 uniapp 手机前端命名规范

结构类型 命名规范与实例 作用
接口(api) 小写,多单词下划线,例如:article.ts,goods_category.ts 为视图提供接口数据
语言包(lang) 语言包文件夹,例如zh-cn,小写,语言包自动根据文件命名,中间文件夹用“.”分割,例如article.edit.json,表示视图view再article下面的edit.json 为视图提供相应的语言定义
视图(views) 对应前端视图页,例如:article.vue 页面视图

选择样式

选择布局
选择颜色
选择背景
选择背景