• linkedu视频
  • 平面设计
  • 电脑入门
  • 操作系统
  • 办公应用
  • 电脑硬件
  • 动画设计
  • 3D设计
  • 网页设计
  • CAD设计
  • 影音处理
  • 数据库
  • 程序设计
  • 认证考试
  • 信息管理
  • 信息安全
菜单
linkedu.com
  • 网页制作
  • 数据库
  • 程序设计
  • 操作系统
  • CMS教程
  • 游戏攻略
  • 脚本语言
  • 平面设计
  • 软件教程
  • 网络安全
  • 电脑知识
  • 服务器
  • 视频教程
  • dedecms
  • ecshop
  • z-blog
  • UcHome
  • UCenter
  • drupal
  • WordPress
  • 帝国cms
  • phpcms
  • 动易cms
  • phpwind
  • discuz
  • 科汛cms
  • 风讯cms
  • 建站教程
  • 运营技巧
您的位置:首页 > CMS教程 >建站教程 > 分享个人推荐的Laravel或其它框架的编程规范

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

作者:站长图库 字体:[增加 减小] 来源:互联网 时间:2022-04-29

站长图库向大家介绍了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

<?php namespace 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 模型工厂

规范定义

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

命名 - 思维导图

602235cdcdce2.jpg

结语

希望我的个人建议,能在同学们间推行与流行起来。


分享到:QQ空间新浪微博腾讯微博微信百度贴吧QQ好友复制网址打印

您可能想查找下面的文章:

  • laravel与thinkphp之间的区别与优缺点
  • 说说在Laravel中怎么执行Shell命令 ?
  • Laravel中用Observer事件致Redis队列异常问题
  • 手把手带你使用Vue + Laravel开发一个简单的 CRUD 应用
  • 分享个人推荐的Laravel或其它框架的编程规范
  • Laravel中三种中间件的作用
  • 解决Laravel使用laravel-excel扩展包(maatwebsite/excel)导入报错问题
  • 分享一个顺丰同城配送的扩展包并在laravel中使用
  • 介绍Laravel8路由模块新增missing方法
  • 解析如何进行Laravel表单验证分层设计和验证场景应用

相关文章

  • 2022-04-29浅谈nodejs利用node-xlsx模块读取excel数据的方法
  • 2022-04-29解析如何进行Laravel表单验证分层设计和验证场景应用
  • 2022-04-29Discuz后台计划任务不运行解决方法
  • 2022-04-29Photoshop调出梦幻炫彩的菱形背景图
  • 2022-04-29五步搞定Laravel Migrations的使用
  • 2022-04-29AI绘制质感电池图标
  • 2022-04-29uniapp中怎么实现直播旁路推流(步骤分享)
  • 2022-04-29做seo排名时你的侧重点是什么
  • 2022-04-29教你怎么使用Vue实现动画效果(附代码)
  • 2022-04-29CorelDraw交互式调和工具制作卡通彩虹

文章分类

  • dedecms
  • ecshop
  • z-blog
  • UcHome
  • UCenter
  • drupal
  • WordPress
  • 帝国cms
  • phpcms
  • 动易cms
  • phpwind
  • discuz
  • 科汛cms
  • 风讯cms
  • 建站教程
  • 运营技巧

最近更新的内容

    • CentOS7如何使用yum安装PHP7.3
    • 总结分享: 6 种JavaScript的打断点的方式(收藏学习)
    • 宝塔2.x面板文件不小心被误删或损坏的修复方法
    • CSS实现领积分动画效果
    • 如何增加外链,增加外链方法汇总
    • Thinkphp5分页函数paginate中的each()传入自定义参数
    • CSS3如何实现图片木桶布局?(附代码)
    • Linux怎么查看程序是否在运行状态
    • Thinkphp5.0框架的Db操作实例分析【连接、增删改查、链式操作等】
    • Wordpress如何调用个人信息

关于我们 - 联系我们 - 免责声明 - 网站地图

©2020-2025 All Rights Reserved. linkedu.com 版权所有