README

xiao

  1. API func 命名格式

    APIPOSTOrder

  2. JSON 返回字段 驼峰命名

  3. 能用驼峰则用驼峰

  4. URL中用驼峰命名

  5. 页面的URL用连字符

Expand ▾ Collapse ▴

Documentation

Overview

xiao 为系统中台和底层的核心框架,会包含业务模块,快速支撑相关业务

Source Files

Directories

Path Synopsis
automation automation 自动更新,原本是依赖 git 拉取代码更新做的 后面暂时没有在使用
book book 知识手册项目的核心代码包
cache Package cache 开始全系统增加缓存功能 目前的缓存实现流程是 在缓存包里增加业务同名方法函数,进行缓存的处理 这里目前有个问题 就是产生数据修改的时候没有强制性的修改缓存,可能会出现漏掉清理缓存而产生的数据不一致的问题
cms cms 公司应用,用于查询订单在cms中全流程的状态
comment comment 评论模块 目前有添加、获取两个api
config config 系统底层的配置文件相关模块 支持第三方应用的 kv 配置 支持定义各种数据库连接格式 做了些基础设置和模板函数
controllers 理论上来说做了前后端分离,这些通用页面的路由层应该逐步去除或者归结到对应业务模块里
corn 定时任务模块,目前已interface的形式挂载,统一处理定时任务的执行操作
coupon 优惠券,给宠物用的 如第三方也要用,需要重新审核代码 Package coupon 优惠券包 @since 0.0.4
course 课程模块,用于edu项目
credit 积分模块,初步可使用可增减,有记录 用户uid 需要确认
etcd 封装了一些 etcd 的常用操作 之前是给 plemis 使用的 , 后续看缓存或者配置文件是否要用 etcd --listen-client-urls http://0.0.0.0:2379 --advertise-client-urls http://0.0.0.0:2379 https://skyao.gitbooks.io/learning-etcd3/content/documentation/op-guide/configuration.html#--advertise-client-urls https://etcd.readthedocs.io/en/latest/
excel 用于 vue.ant 前台表格生成 excel 文件的 支持定制表头表尾 即将成为共用模块 excel @since 0.0.11 模板生成
global Package datatablessrv handles the server side processing of an AJAX request for DataTables For details on the parameters and the results, read the datatables documentation at https://datatables.net/manual/server-side 全局模块 定义了一些 API 的正确错误返回格式 通过session jwt 获取用户uid 日志 markdown 等功能 global log 日志处理包 @since 0.0.4
goods 商品模块,此模块相对来说代码质量是有保证的,可以正常使用但是要排计划做测试用例
jwt 目前应该有三处用到 jwt 1.
label 标签模块 用分类的方式实现 类型为 label 的相关操作 这个应该合并到分类模块里
mall 未实现
model Package model 尝试缓存友好的编写 log db @since 0.0.4 定义框架需要支持的基础数据库类型字段和一些数据库连接句柄等相关处理 做过一些业务的new方法 后面应该补全
monitor 监控功能,将日志的后五百行显示出来,目前是按页面显示的 需要抽离成api
openTracing 全链路检测,之前启用过,但是ctx目前没有良好的解决方案,暂时搁置掉了
oss 阿里云 oss 的相关处理包,kv在代码里存了,安全性有问题 需要增加定时删除的 定时任务
pagination 尝试用通用的分页功能来实现vue组件的数据交互 未完成
pdf
permission 权限模块 前后改的乱七八糟的,最后用 casbin 来实现,使用方法还要学习
post 文章模块,大问题应该没有太多就是查询效率和新旧查询代码太多的问题 趁着这次前后端分离需要好好整理一番
router 框架默认需要支持的路由 前后端分离后需要清理一批路由
shop
shop/order
sms 短信发送模块,调用阿里云的短信服务 依旧有安全问题
table 用于可配置的形式给vue table 组件告知前端要显示那些列,功能十分有限 目前只在 post 模块的一处尝试使用
tag 给文章添加标签 这个也应该合并到分类模块里 只是分类的key的问题
taxonomy Package taxonomy 处理分类相关的问题,菜单也是放在这里解决的 这里一定要注意,termID 不是用于界面上传递的主Key而是TermTaxonomyID 代码质量还行
ucenter 用户中心模块 说来说去,还是只实现了基础的功能,要抓紧时间完善
wechat 微信模块,目前是给公司企业号进行的相关处理,要从客户脱离出来 根据业务key发送信息 目前业务代码太重,要重构
wechat/mp
wechatClient 用于其他golang代码包相对轻松的调用发送微信通知 需要增加测试,提升代码质量