开发规范

浏览数 99109 最后修改时间
命名规范
YiluPHP默认遵循php命名规则,全部小写字母、单词之间使用下划线分隔,但在编程界里驼峰式命名规则也是非常普遍的,改变这个习惯是非常难受的,因此YiluPHP也同时支持驼峰式命名规则,比如 model_user 和 modelUser 都是可以的,不影响类的自动加载。
类文件的存放
在YiluPHP中增加一个类,不需要配置也不需要引入,使用   $app->[类名]   的方式就可以直接调用,为了给不同功能的类,使用前缀分类标识,例如 model_ 开头或驼峰式 model 的就是模式类,它们存放在 model 目录中,目录名和类名前缀需要一致,类的文件名和类名需要一致。YiluPHP框架已经创建了四个存放类的目录: 辅助类helper、模型类model、逻辑类logic、钩子hook,你可以根据你的设计随意得创建目录,例如:工具类tool、服务类service、路由route、插件plugin、扩展exception、其它库类library,只要你喜欢,只要符合目录名和类名前缀需要一致,类的文件名和类名需要一致。
helper目录是不能删除的,YiluPHP加载类的顺序是先检查helper目录,再检查类前缀所示的目录,所以你把所有其它目录的类都拷贝到helper目录,程序执行会更加迅速,如果你的项目被分成多个小系统,只有几十分类文件,那全部放在 helper 目录是最好的选择。


YiluPHP占用了5个类名,注意你定义的类名不要与YiluPHP的保留名称冲突了。你可能需要定义以下类型的类:辅助类helper、钩子hook、逻辑处理类logic、数据模型model、工具类tool、服务类service、路由route、插件plugin、扩展exception、其它库类library,不管你是如何分类取名,只要保持目录名、类文件名前缀和类名前缀一致,类文件名和类名一致,不需要引入也不需要配置,通过   $app->[类名]->[方法]()   就可以直接使用。建立文件就可以直接使用,如此方便的方式减少了学习成本也节省了开发时间。
另外YiluPHP官网有个”一起开发“的计划,只要不涉及到你们项目的核心算法和泄露数据,你可以把你的函数和类分享到YiluPHP官网上,一个函数建立一篇文章、一个类库也建立一篇文章,所有开发者一起维护函数库和类库,资源共享可以节省开发成本。官网分享的函数和类名是唯一的,可以确保类拷贝过来即可使用。如果你想使用的名称已经存在,你可以对比类的功能用途,或直接使用已有的类、或在优化它的功能并在评论处分享出来、或换一个名称开启一个不同用途的类,如果你认为原有的类名称取得不够合理,可以联系作者协商换一个名称。



我来说说