分享针对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

    结语

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

对我有帮助
19人认为有帮助

相关帮助