放置位置

所有的数据模型文件，都 必须 存放在：app/Models/ 文件夹中。

命名空间：

  1. namespace App\Models;

User.php

Laravel 5.1 默认安装会把 User 模型存放在 app/User.php，必须 移动到 app/Models 文件夹中，并修改命名空间声明为 App/Models，同上。

为了不破坏原有的逻辑点，必须 全局搜索 App/User 并替换为 App/Models/User。

使用基类

所有的 Eloquent 数据模型 都 必须 继承统一的基类 App/Models/Model，此基类存放位置为 /app/Models/Model.php，内容参考以下：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model as EloquentModel;

class Model extends EloquentModel
{
    public function scopeRecent($query)
    {
        return $query->orderBy('created_at', 'desc');
    }
}

以 Photo 数据模型作为例子继承 Model 基类：

<?php

namespace App\Models;

class Photo extends Model
{
    protected $fillable = ['id', 'user_id'];

    public function user()
    {
        return $this->belongsTo(User::class);
    }
}

命名规范

数据模型相关命名规范：

  • 数据模型类名 必须 为「单数」, 如：App\Models\Photo
  • 数据模型变量 必须 为「resource_id」，如：$user_id, $post_id
  • 数据库表迁移名称 必须 为「复数」，如：`2014_08_08_234417_create_photos_table.php

数据库相关命名规范：

  • 数据库表名称 必须 为「复数」，多个单词情况下 必须 使用「蛇形命名法」 如：photos, my_photos
  • 数据库表名称最多 不能 超过四个英文单词。不能 使用中文拼音。
  • 数据库 业务表 名称 必须 为 项目名称_模块名称_表名称，如：icp_project_projects, icp_project_plans
  • 数据库 系统表 名称 必须 为 sys_表名称，如：sys_departments, sys_dicts
  • 数据库 框架表 名称 不能 添加前缀，如：migrations, logs
  • 数据库 多对多关联表 名称 必须 为 「复数」，x_articles_images
  • 数据库字段名 必须 为小写字母，且多个单词情况下 必须 使用「蛇形命名法」，如：center_point, created_at
  • 数据库表主键 必须 为「id」
  • 数据库表外键 必须 为「resource_id」，如：user_id, post_id

利用 Trait 来扩展数据模型

有时候数据模型里的代码会变得很臃肿，应该 利用 Trait 来精简逻辑代码量，提高可读性，类似于 Ruby China 源码。

借鉴于 Rails 的设计理念：「Fat Models, Skinny Controllers」。

存放于文件夹：app/Models/Traits 文件夹中。

Repository

绝不 使用 Repository，因为我们不是在写 JAVA 代码，太多封装就成了「过度设计（Over Designed）」，极大降低了编码愉悦感，使用 MVC 够傻够简单。

代码的可读性，维护和开发的便捷性，直接关系到程序员开发时的愉悦感，直接影响到项目推进效率和程序 Debug 的速度。

关于 SQL 文件

  • 绝不 使用命令行或者 PHPMyAdmin 直接创建索引或表。必须 使用 数据库迁移 去创建表结构，并提交版本控制器中；
  • 绝不 为了共享对数据库更改就直接导出 SQL，所有修改都 必须 使用 数据库迁移 ，并提交版本控制器中；
  • 绝不 直接向数据库手动写入伪造的测试数据。必须 使用 数据填充 来插入假数据，并提交版本控制器中。

全局作用域

Laravel 的 Model 全局作用域 允许我们为给定模型的所有查询添加默认的条件约束。

所有的全局作用域都 必须 统一使用 闭包定义全局作用域，如下：

/**
 * 数据模型的启动方法
 *
 * @return void
 */
protected static function boot()
{
    parent::boot();

    static::addGlobalScope('age', function(Builder $builder) {
        $builder->where('age', '>', 200);
    });
}