Skip to content

约定

约定大于配置, 这句名言相信很多人都听过。不管是框架还是 package 都遵循一定约定,在了解这些约定之后,开发将变得简单,CatchAdmin 也是,也有一些约定。开发前需要了解

WARNING

下面的约定是基于 Master 分支,目前默认分支切换到了 Server 分支,但是约定的思想不变

  • 后台功能约定在 modules 目录下

  • 模块的页面在 modules/Permissions/views

    INFO

    为什么将 views 放在模块下,而不是前端项目? 如果有一个模块共享给别人,直接放到 modules 下就可以了 后台再添加菜单的时候,也可以很方便选择页面组件

  • resource/admin 目录是前端开发目录,主要用于公共组件开发

  • 枚举类型需要实现 Catch\Enums\Enum 接口

    INFO

    框架最低版本要求 8.1,所以可以使用新增枚举类型 enum

  • 枚举如果是整型,那么从 1 开始

    INFO

    为什么要从 1 开始?因为枚举值集合一般会用于列表查询,PHP 由于是弱类型的原因,对于 0 null 空字符串,在不用===的情况下,都是一样的。

  • 公共的请求或者公共方法都放在内置的 Common 模块

    • 上传功能
    • 前端的枚举集合请求
  • 如果不需要动态菜单,那么前端路由需要放在模块的 views 目录下, 并且命名为route.js

    INFO

    可以从 develop 或者 user 模块中找到相关开发信息