您的位置: 翼速应用 > 业内知识 > PHP框架 > 正文

分享针对laravel或其他框架的个人推荐编程规范

    前情提要

    在开发过程中,许多学生在文件命名中容易出现混乱,随机和缺乏统一性的情况。当多个人合作时,这种情况尤其突出。所有开发人员都必须适应每个人的开发习惯。许多不便之处阻碍了多人协作开发的效率。


    统一规范

    使用统一的开发规范,好处甚多。减少开发间的磨合,是其一,举例:

    app/Models/User.php

1.png

    在行参 $user_id 的注释里,我使用的是 users.id 的形式。此形式是我主推的,优点是直观的知道此参数的由来(users 表中 id 字段)。

    返回的参数也做了直观的说明,取值为 users 表中 username 字段的值。

    function 命名按照动作来区分命名,get + 字段 取值,set + 字段 更新值。


    命名统一

    下面,我通过 users 表举例,列举我推荐命名的逻辑。


    table - users

    以 users 表来作为蓝本,向同学们推行此规范。


    migrations - 数据库迁移

    database/migrations/xxxx_create_users_table.php

2.png

    model - 模型

    app/Models/User.php


    controller - 控制器

    app/Http/Controllers/UserController.php

3.png

    request - 表单验证

    app/Http/Requests/UserRequest.php


    observer - 观察者

    app/Observers/UserObserver.php


    event - 事件系统

    app/Events/UserEvent.php 事件

    app/Listeners/UserListener.php 监听器

    console - 任务调度

    app/Console/Commands/UserCommand.php

4.png

    seeder - 数据填充

    database/seeds/UserSeeder.php 生成假数据

    database/factories/UserFactory.php 模型工厂

    规范定义

    我将上面此种规范定义为 以表规名,对此的解释是,以表名为主线,规定其相关业务的文件,均以表名为关键字进行后续文件的命名。


    命名 - 思维导图

5.png

    结语

    我希望我的个人建议能够在学习中得到贯彻和普及。感谢您的阅读,并记住要喜欢,评论,收藏和转发给我。

我来说两句

0 条评论

推荐阅读

  • 响应式布局CSS媒体查询设备像素比介绍

    构建响应式网站布局最常见的是流体网格,灵活调整大小的站点布局技术,确保用户在使用的幕上获得完整的体验。响应式设计如何展示富媒体图像,可以通过以下几种方法。

    admin
  • 提升网站的性能快速加载的实用技巧

    网站速度很重要,快速加载的网站会带来更好的用户体验、更高的转化率、更多的参与度,而且在搜索引擎排名中也扮演重要角色,做SEO,网站硬件是起跑线,如果输在了起跑线,又怎么跟同行竞争。有许多方法可提升网站的性能,有一些技巧可以避免踩坑。

    admin
  • 织梦CMS TAG页找不到标签和实现彩色标签解决方法

    织梦cms是我们常见的网站程序系统的一款,在TAG标签中常常遇到的问题也很多。当我们点击 tags.php 页的某个标签的时候,有时会提示:“系统无此标签,可 能已经移除!” 但是我们检查程序后台,以及前台显示页面。这个标签确实存在,如果解决这个问题那?

    admin
  • HTML关于fieldset标签主要的作用

    在前端开发html页面中常用的标签很多,今天为大家带来的是关于HTML中fieldset标签主要的作用说明,根据技术分析HTML

    admin

精选专题