发表更新Php / Laravel / 数据库 / 模型

Laravel Eloquent 和 Migrate

Eloquent 技巧

1. 获取并更新更改为直接更新

两条Sql 查询记录

1
2
3
$pam = PamAccount::find(1);
$pam->login_times++;
$pam->save();
1
2
3
4
5
6
+----------------------------------------------------------------------------------------------------------------+------+
| Query                                                                                                          | Time |
+----------------------------------------------------------------------------------------------------------------+------+
| select * from `pam_account` where `pam_account`.`id` = 1 limit 1                                               | 3.32 |
| update `pam_account` set `login_times` = 10, `pam_account`.`updated_at` = "2022-12-03 21:21:16" where `id` = 1 | 0.29 |
+----------------------------------------------------------------------------------------------------------------+------+

改写为一条查询语句

1
2
3
4
5
// 不太优雅
PamAccount::where('id', 1)->increment('login_times');

// 更加优雅的写法
PamAccount::whereKey(1)->increment('login_times');
1
2
3
4
5
+---------------------------------------------------------------------------------------------------------------------------------------------+------+
| Query                                                                                                                                       | Time |
+---------------------------------------------------------------------------------------------------------------------------------------------+------+
| update `pam_account` set `login_times` = `login_times` + 1, `pam_account`.`updated_at` = "2022-12-03 21:21:16" where `pam_account`.`id` = 1 | 0.24 |
+---------------------------------------------------------------------------------------------------------------------------------------------+------+

2. 带条件的关联关系模型

  • 多条件

通常定义关系模型的方法是这样的

1
2
3
public function users() {
  return $this->hasMany('App\User');
}

但是否知道在定义关系模型的时候已经可以增加 where 或者 orderBy 的条件了？ 比如说你需要定义一个特定类型的用户的关联关系并且用邮箱信息来排序，那你可以这么做：

1
2
3
public function approvedUsers() {
    return $this->hasMany('App\User')->where('approved', 1)->orderBy('email');
}
  • 单条件
1
2
3
public function latestPost(){
    return $this->hasOne(\App\Post::class)->latest();
}
  • 默认

这样在没有最新帖子的时候返回默认的空模型数据

1
2
3
public function latestPost(){
    return $this->hasOne(\App\Post::class)->withDefault();
}

3. 模型中的附加属性 appends

appends : 输出时候附加的额外属性，通过模型中定义 getXXXAttribute 的方式来定义

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
class PhpDemo extends Model
{

    public $timestamps = false;

    protected $table = 'php_demo';

    protected $appends = [
        'title_md5',
    ];

    protected $fillable = [
        'id',
        'title',
    ];

    public function getTitleMd5Attribute(): string
    {
        return md5($this->attributes['title']);
    }
}

其他的模型相关属性

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
class PhpDemo extends Model
{

    public $timestamps = false;

    protected $table = 'php_demo';

    protected $appends = [
        'title_md5',
    ];

    protected $fillable = [
        'id',
        'title',
    ];

    public function getTitleMd5Attribute(): string
    {
        return md5($this->attributes['title']);
    }
}

4. find 查找多个

1
2
// 返回 Collection 类型
PhpDemo::find([1, 2]);

5. whereX 魔术方法

这里列举时间相关

1
2
3
4
5
6
7
8
9
10
11
// old way
if (request('filter_by') == 'date') {
    $query->orderBy('created_at', request('ordering_rule', 'desc'));
}

// new way
$query = User::query();
$query->when(request('role', false), function ($q, $role) { 
    return $q->where('role_id', $role);
});
$authors = $query->get();

6. when 方法

是不是感觉高大上和优雅了一些

1
2
3
4
5
6
7
8
9
10
11
// old way
if (request('filter_by') == 'date') {
    $query->orderBy('created_at', request('ordering_rule', 'desc'));
}

// new way
$query = User::query();
$query->when(request('role', false), function ($q, $role) { 
    return $q->where('role_id', $role);
});
$authors = $query->get();

7. 全局范围

这里使用到了 Eloquent 的 boot 静态方法来注册全局范围查询条件

1
2
3
4
5
6
7
8
9
protected static function boot()
{
    parent::boot();

    // 默认按照name 字段升序
    static::addGlobalScope('order', function (Builder $builder) {
        $builder->orderBy('name', 'asc');
    });
}

8. 数据副本

1
2
3
$task = Tasks::find(1);
$newTask = $task->replicate();
$newTask->save();

9. 模型 chunk 方法

使用模型的方法分批次从数据库中获取数据而不是取出所有的数据

1
2
3
4
5
PhpDemo::chunk(50, function ($users) {
    foreach ($users as $user) {
        // ...
    }
});

查看所有的 sql 请求, 类似于数据分片

1
2
3
4
5
6
+--------------------------------------------------------------------------+-------+
| Query                                                                    | Time  |
+--------------------------------------------------------------------------+-------+
| select * from `php_demo` order by `php_demo`.`id` asc limit 50 offset 0  | 17.09 |
| select * from `php_demo` order by `php_demo`.`id` asc limit 50 offset 50 | 0.4   |
+--------------------------------------------------------------------------+-------+

10 在保存的时候可以按照我们的预期更新 updated_at 字段么

通过 save 传递参数忽略模型自己填充的更新数据

1
2
3
$product = Product::find($id);
$product->updated_at = '2019-01-01 10:00:00';
$product->save(['timestamps' => false]);

11. Model 的几个使用方式

连表

1
2
3
4
5
6
7
$tbPam   = (new PamAccount())->getTable();
$tbFt    = (new AccountFront())->getTable();
$Db = \DB::table($tbPam)->where('account_type', 'front');
$Db->where($tbPam . '.account_id', '!=', \FrontAuth::id());
$Db->join($tbFt, $tbPam . '.account_id', '=', $tbFt . '.account_id');
$accounts = $Db->paginate(16);
$accounts->appends($request->input());

多字段的的 Like 查询

1
2
3
4
5
6
7
$kw = input('kw');
if ($kw) {
    $Db->where(function($query) use ($kw, $tb_weixin){
        $query->orWhere($tb_weixin.'.wx_account', 'like', '%'.$kw.'%');
        $query->orWhere($tb_weixin.'.wx_nickname', 'like', '%'.$kw.'%');
    });
}

数据库 Migrate 和 Seeder

数据库配置

配置文件 config/database.php

由于数据库中定义调用了 .env 的方法, 所以这里使用 .env 的方式来加载配置, 如果需要前缀可以修改 env 文件

1
2
3
4
5
6
7
8
9
<?php
return [
    ...
    'mysql' => [
        // ...
        'prefix'    => env('DATABASE_PREFIX', 'db_'),
        // ..
    ],
]

这里需要先创建一个数据库 laravel_get_start

file : .env

1
2
3
4
DB_HOST=127.0.0.1
DB_DATABASE=laravel_get_start
DB_USERNAME=root
DB_PASSWORD=

创建模型

Laravel最为强大的部分，Eloquent ORM, 现在，Artisan 帮我们在 ~/app/Models 下创建了文件 Article.php ，这是 Model 类，他们都继承了 Laravel Eloquent 提供的 Model 类 Illuminate，且都在 \App\Models 命名空间下。这里需要强调一下，用命令行的方式创建文件，和自己手动创建文件没有任何区别，你也可以尝试自己创建这两个 Model 类。

Model 即为 MVC 中的 M，翻译为模型，负责跟数据库交互。在 Eloquent 中，数据库中每一张表对应着一个 Model 类（当然也可以对应多个）。

1
2
3
4
$ php artisan make:model Article

# 创建模型的时候可以创建出 migration 文件
$ php artisan make:model Article -m

创建 Migration

1
$ php artisan make:migration create_articles_table

在 create_articles_table.php 中修改：

1
2
3
4
5
6
7
8
Schema::create('articles', function(Blueprint $table)
{
    $table->increments('id');
    $table->string('title');
    $table->string('slug')->nullable();
    $table->text('body')->nullable();
    $table->timestamps();
});

数据表建立

接下来进行 Article 对应的 articles 表数据库迁移，运行以下命令执行数据库迁移操作：

1
2
3
$ php artisan migrate
Migration table created successfully.
Migrated: 2014_10_12_000000_create_articles_table

数据表进入数据库

填充数据

在 database/seeds/ArticleTableSeeder.php 中添加创建

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?php
use Illuminate\Database\Seeder;
use App\Models\Article;
class ArticleTableSeeder extends Seeder {
    public function run()
    {
        // delete db
        DB::table('articles')->delete();
        // insert
        for ($i=1; $i<=10; $i++) {
            Article::create([
                'title'    => 'title-'.$i,
                'slug' =>  md5($i),
                'body' => 'body-'.$i,
            ]);
        }
    }
}

然后修改同一级目录下的 DatabaseSeeder.php中增加

1
$this->call('ArticleTableSeeder');

你需要在控制台按照如下顺序运行

1
2
composer dump-autoload          # 生成新的类映射文件
php artisan db:seed             # 将种子种进数据库

这样数据就可以进入数据库.

导出 Laravel 迁移文件

在 Sequel Pro 中已存在的数据表导出

对 Laravel 开发者来说，主要有两种方式创建数据表，一种是通过 MySQL 客户端工具，比如 Sequel Pro（Mac 环境下比较流行的 MySQL 客户端软件），另一种是通过 Laravel 提供的 Artisan 命令生成迁移文件。

如果之前的项目不是通过 Laravel 构建的，现在要迁移到 Laravel，或者之前不是通过迁移文件生成的数据表，想要将已存在的数据表转化为 Laravel 迁移文件怎么办，由 Colin Viebrock 为 Sequel Pro 开发的Laravel 迁移导出工具为我们提供了方便。

我们从 github（https://github.com/cviebrock/sequel-pro-laravel-export）将代码克隆本地：

1
git clone https://github.com/cviebrock/sequel-pro-laravel-export.git

然后进入项目目录，双击ExportToLaravelMigration.spBundle文件，接下来在打开的页面连接到数据库，在左侧选中一张数据表，在菜单栏选择Bundles › Export › Export将数据表导出为迁移文件（或者使用快捷命令⌃⌥⌘M）：

这样就会将选中数据表转化为 Laravel 数据库迁移文件并存放在桌面，比如我选中的是users表，对应的迁移文件是2016_11_20_212052_create_users_table.php，文件内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<?php
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
/**
 * Migration auto-generated by Sequel Pro Laravel Export
 * @see https://github.com/cviebrock/sequel-pro-laravel-export
 */
class CreateUsersTable extends Migration {
     /**
      * Run the migrations.
      *
      * @return void
      */
     public function up()
     {
         Schema::create('users', function (Blueprint $table) {
            $table->increments('id');
            $table->string('name', 255);
            $table->string('email', 255);
            $table->string('password', 255);
            $table->rememberToken();
            $table->nullableTimestamps();
            $table->unique('email', 'users_email_unique');
        });
    }
    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('users');
    }
}

我们可以将其拷贝到 Laravel 项目的数据库迁移目录，以便后续使用该文件进行后续操作。

参考

更新记录

2023年02月11日

  • 移除 workbench 导出 migrate
  • 格式化更新

2022年12月03日

  • 移除多余的 Migrate 操作

2014年10月20日

  • 学习 Laravel 记录

参考文章

Laravel Eloquent 和 Migrate

https://wulicode.com/php/laravel-eloquent-migrate.html

作者

Duoli

发布于

2023-03-05

更新于

2023-03-05

许可协议

评论