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

2022-05-15 0 954

下面由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 表来作为蓝本,向同学们推行此规范。

migrations – 数据库迁移

database/migrations/xxxx_create_users_table.php

···use Illuminate\\Support\\Facades\\DB;···    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

<?phpnamespace App\\Http\\Controllers\\Api\\v1;use App\\Http\\Controllers\\Controller;use Illuminate\\Http\\Request;use App\\Models\\User;class UserController extends Controller{    public function index(Request $request)    {        // todo    }// index() end    public function show(Request $request)    {        // 变量命名,对应的是表字段的话,变量名建议以该字段为名,        // 注释时采用 表名.字段 的形式        // users.username        $username = $request->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或其它框架的编程规范

结语

希望我的个人建议,能在同学们间推行与流行起来。谢谢同学们的阅读,记得帮我 点赞评论收藏转发

收藏 (0) 打赏

感谢您的支持,我会继续努力的!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

【声明:根据2013年1月30日《计算机软件保护条例》2次修订第17条规定: 为了学习和研究软件内含的设计思想和原理,通过安装、显示、传输或者存 储软件等方式使用软件的,可以不经软件著作权人许可,不向其支付报酬! 鉴于此,也希望大家按此说明研究软件!】
本站所有源码尽量保证原汁原味,如有特殊情况会作出声明及标注,网站资源不做任何二次加密(原版加密除外,不影响程序使用的不会做解密处理),方便您更好的学习参考。 在您的能力范围内,为了大环境的良性发展,请尽可能的选择正版资源。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。

即刻码站__国内靠谱的站长资源下载平台 php教程 分享个人推荐的laravel或其它框架的编程规范 https://www.jike1995.com/36830.html

常见问题
  • 本站所有资源版权均属于原作者所有,这里所提供资源均只能用于参考学习用,请勿直接商用。若由于商用引起版权纠纷,一切责任均由使用
查看详情
  • 最常见的情况是下载不完整: 可对比下载完压缩包的与网盘上的容量,若小于网盘提示的容量则是这个原因。这是浏览器下载的bug,建议用百度
查看详情

相关文章

发表评论
暂无评论
官方客服团队

为您解决烦忧 - 24小时在线 专业服务