下面由Laravel教程栏目给大家介绍个人推荐的 laravel 或其它框架的编程规范,希望对需要的朋友有所帮助！
前情提要
在开发的时候，许多同学在文件命名方面，容易出现絮乱，随意性强，没有统一性。此种情况，在多人协同时，尤为突出。各开发人员都要去适应每个人的开发习惯，诸多不便，阻碍了多人协同开发的效率。
统一规范
使用统一的开发规范，好处甚多。减少开发间的磨合，是其一，举例：
app/Models/User.php
···/** * @desc 获取 users.username * @param int $user_id users.id * @return string */public static function getUsername(int $user_id): string{ return self::where('id', $user_id)->value('username');}// getUsername() end/** * @desc 获取 users.age * @param int $user_id users.id * @return int */public static function getAge(int $user_id): int{ return (int)self::where('id', $user_id)->value('age');}// getAge() end···
在行参 $user_id 的注释里，我使用的是 users.id 的形式。此形式是我主推的，优点是直观的知道此参数的由来（users 表中 id 字段）。
返回的参数也做了直观的说明，取值为 users 表中 username 字段的值。function 命名按照动作来区分命名，get + 字段 取值，set + 字段 更新值。
命名统一
下面，我通过 users 表举例，列举我推荐命名的逻辑。
table – users
以 users 表来作为蓝本，向同学们推行此规范。
立即进入“豆包AI人工智官网入口”；
立即学习“豆包AI人工智能在线问答入口”；
migrations – 数据库迁移
database/migrations/xxxx_create_users_table.php
···use IlluminateSupportFacadesDB;··· Schema::create('balance_logs', function (Blueprint $table) { $table->id(); $table->string('username', 32)->unique()->nullable(false)->comment('名称'); $table->string('password', 128)->nullable(false)->comment('密码'); $table->unsignedInteger('age', 3)->default(0)->comment('年龄'); $table->string('token', 128)->nullable(true)->comment('登录态'); $table->dateTime('created_at')->useCurrent(); $table->dateTime('updated_at')->useCurrent(); $table->index('username', 'username_index'); }); DB::statement("ALTER TABLE `users` comment '用户表'");···
model – 模型
app/Models/User.php
controller – 控制器
app/Http/Controllers/UserController.php
post('username'); }// show() end public function store(Request $request) { $user_id = $request->post('user_id');// users.id $age = $request->post('age'); // users.age // 更新数据 User::where('id', $user_id)->update(['age' => $age]); }// store() end}
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
$ php artisan my:user
seeder – 数据填充
database/seeds/UserSeeder.php 生成假数据database/factories/UserFactory.php 模型工厂
规范定义
我将上面此种规范定义为 以表规名，对此的解释是，以表名为主线，规定其相关业务的文件，均以表名为关键字进行后续文件的命名。
命名 – 思维导图
结语
希望我的个人建议，能在同学们间推行与流行起来。谢谢同学们的阅读，记得帮我 点赞、评论、收藏、转发。
以上就是分享个人推荐的laravel或其它框架的编程规范的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/79212.html
微信扫一扫 
支付宝扫一扫 
