PHP
话题列表 社区 Wiki 优质外文 招聘求职 PHP 实战教程 社区文档
登录
注册

php强类型编码下的db操作类设计思考

梦想星辰大海 的个人博客 / 69 / 5 / 创建于 3周前

我对php代码的编写，有一个要求是编写出编辑器可读的代码，换句话说就是编辑器能够点击跳转的代码。
如今的db操作库在执行查询方法后，返回的数据要么是collection集合，要么是mixed类型，编辑器无法提示返回值里面具体有什么。
所以我写了一些伪代码，大伙看看这个设计有没有搞头，或者有没有类似的解决方案。

定义PrimaryKey注解

<?php

namespace App\Models\Test;

use Attribute;

/**
 * 标记主键
 */
#[Attribute] class PrimaryKey
{
}

定义DB类

<?php

namespace App\Models\Test;

use ReflectionClass;
use ReflectionProperty;

class DB
{
    protected string $connection = '';
    protected string $table = '';

    /**
     * 查询条件
     * @param string $column 查询列
     * @param string|null $operator 查询操作符
     * @param mixed|null $value 查询值
     * @param string $boolean 查询条件连接符
     * @return $this
     */
    public function where(string $column, string|null $operator = null, mixed $value = null, string $boolean = 'and'): static
    {
        return $this;
    }

    /**
     * 获取所有
     * @return array|static[]
     */
    public function get(): array
    {
        return [
            new static(),
            new static()
        ];
    }

    /**
     * 获取第一个
     * @return $this|null
     */
    public function find(): static|null
    {
        return new static;
    }

    /**
     * 转换为数组
     * @return array
     */
    public function toArray(): array
    {
        //反射子类，并遍历子类的属性
        $reflection = new ReflectionClass($this);
        $properties = $reflection->getProperties(ReflectionProperty::IS_PUBLIC);
        $data = [];
        foreach ($properties as $property) {
            $propertyName = $property->getName();
            $data[$propertyName] = $this->$propertyName;
        }
        return $data;
    }

    /**
     * 删除
     * @return int 删除的行数
     */
    public function delete(): int
    {
        return 1;
    }

    /**
     * 创建
     * @return bool 创建成功或失败
     */
    public function create(): bool
    {
        return 1;
    }

    /**
     * 更新
     * @return int 更新的行数
     */
    public function update(): int
    {
        return 1;
    }
}

定义表user的模型

<?php

namespace App\Models\Test;

class  User extends  DB
{
    protected string $connection = 'test_db';
    protected string $table = 'user';
    #[PrimaryKey]
    public int $userId = 0;
    public string $username = '';
    public string $password = '';
    public string $nickname = '';
    public string $avatar = '';
}

定义表order的模型

<?php

namespace App\Models\Test;

class Order extends  DB
{
    protected string $connection = 'test_db';
    protected string $table = 'order';
    #[PrimaryKey]
    public int $orderNo = 0;
    public int $userId = 0;
    public int $amount = 0;
    /**
     * @var int 订单状态【0:待支付 1:支付成功 2:支付失败】
     */
    public int $status = 0;

    const STATUS_WAIT = 0;
    const STATUS_SUCCESS = 1;
    const STATUS_FAIL = 2;
}

增删改查示例

<?php

namespace App\Http\Controllers;

use App\Models\Test\Order;
use App\Models\Test\User;
use Symfony\Component\HttpFoundation\Response;

class TestController extends Controller
{
    /**
     * 查询示例
     * @return Response
     */
    public function index(): Response
    {
        $admin = (new User)->where('username', '=', 'admin')->find();
        $users = (new User)->where('nickname', 'like', "%$admin->nickname%")->get();
        $ret = [];
        foreach ($users as $user) {
            $tmp = [
                'username' => $user->username,
                'nickname' => $user->nickname,
                'avatar' => $user->avatar
            ];
            $order = (new Order)->where('user_id', '=', $user->userId)->find();
            if ($order && $order->status = Order::STATUS_SUCCESS) {
                $tmp['order'] = $order->toArray();
            } else {
                $tmp['order'] = null;
            }
            $ret[] = $tmp;
        }
        return $this->success($ret);
    }

    /**
     * 新增示例
     * @return Response
     */
    public function create(): Response
    {
        $user = new User();
        $user->username = 'test';
        $user->nickname = 'test';
        $user->avatar = 'test';
        return $user->create() ? $this->success() : $this->error('新增失败', 1);
    }

    /**
     * 删除示例
     * @return Response
     */
    public function delete(): Response
    {
        $ok = (new Order)->where('user_id', '=', 1)->delete();
        return $ok ? $this->success() : $this->error('删除失败', 1);
    }

    /**
     * 更新示例
     * @return Response
     */
    public function update(): Response
    {
        $user = new User();
        $user->username = 'test';
        $ok = $user->where('userId', '=', 1)->update();
        return $ok ? $this->success() : $this->error('更新失败', 1);
    }
}

优缺点分析：

  • 优点：get或find返回的数据，编辑器是可是识别的。
  • 缺点：使用返回的数据时，编辑器既提示了表模型本身的属性字段，也提示了表模型父类的方法，这些方法在操作返回值的时候也会提示，属于提示噪音。

“提示”噪音的解决思路

首先是表模型不再继承DB类，然后是改造DB类的find和get方法。
find方法返回单条数据时，可以改为传递model对象，并将查询的数据填写到对象身上，类似go中的设计：

order := TestDbEntity.Order{}
TestDbDao.Order.Scan(&order)

但是get方法返回的是多条数据，此时由于php没有强类型的数组，并不能像go一样，实现如下的写法：

var orderList []TestDbEntity.Order
TestDbDao.Order.Scan(&orderList)

折中的思路是让表模型继承一个基础模型，然后基础模型提供public static function makes(): array方法。
整个实现如下：

定义ModelInterface接口

<?php

namespace App\Models\Test;

interface ModelInterface
{
    public static function getConnection(): string;

    public static function getTable(): string;

    public static function makes(): array;

    public static function make(): static;

    public function toArray(): array;
}

实现ModelInterface接口

<?php

namespace App\Models\Test;

use ReflectionClass;
use ReflectionProperty;

class  Model implements ModelInterface
{
    protected static string $connection = '';
    protected static string $table = '';

    /**
     * @return array | static[]
     */
    public static function makes(): array
    {
        return [];
    }

    /**
     * @return static
     */
    public static function make(): static
    {
        return new static();
    }

    public static function getConnection(): string
    {
        return static::$connection;
    }

    public static function getTable(): string
    {
        return static::$table;
    }

    /**
     * 转换为数组
     * @return array
     */
    public function toArray(): array
    {
        //反射子类，并遍历子类的属性
        $reflection = new ReflectionClass($this);
        $properties = $reflection->getProperties(ReflectionProperty::IS_PUBLIC);
        $data = [];
        foreach ($properties as $property) {
            $propertyName = $property->getName();
            $data[$propertyName] = $this->$propertyName;
        }
        return $data;
    }

}

表模型继承基础Model类

<?php

namespace App\Models\Test;

class Order extends Model
{
    protected static string $connection = 'test_db';
    protected static string $table = 'order';
    #[PrimaryKey]
  public int $orderNo = 0;
    public int $userId = 0;
    public int $amount = 0;
    /**
 * @var int 订单状态【0:待支付 1:支付成功 2:支付失败】
  */
  public int $status = 0;

    const STATUS_WAIT = 0;
    const STATUS_SUCCESS = 1;
    const STATUS_FAIL = 2;
}
<?php

namespace App\Models\Test;

class  User extends Model
{
    protected static string $connection = 'test_db';
    protected static string $table = 'user';
    #[PrimaryKey]
    public int $userId = 0;
    public string $username = '';
    public string $password = '';
    public string $nickname = '';
    public string $avatar = '';
}

改写DB类

<?php

namespace App\Models\Test;

class DB
{
    protected string $connection = '';
    protected string $table = '';
    /**
     * @var string |ModelInterface
     */
    protected string|ModelInterface $model = '';

    public static function make(string $model): static
    {
        $ret = new static;
        $ret->model = $model;
        return $ret;
    }

    /**
     * 查询条件
     * @param string $column 查询列
     * @param string|null $operator 查询操作符
     * @param mixed|null $value 查询值
     * @param string $boolean 查询条件连接符
     * @return $this
     */
    public function where(string $column, string|null $operator = null, mixed $value = null, string $boolean = 'and'): static
    {
        return $this;
    }

    /**
     * 获取列表
     * @param array|ModelInterface[] $models
     */
    public function get(array &$models): void
    {
        $models[] = $this->model::make();
        $models[] = $this->model::make();
    }

    /**
     * 获取第一个
     * @param ModelInterface $model
     * @return bool
     */
    public function find(ModelInterface $model): bool
    {
        return true;
    }

    /**
     * 删除
     * @return int 删除的行数
     */
    public function delete(): int
    {
        return 1;
    }

    /**
     * 创建
     * @return bool 创建成功或失败
     */
    public function create(ModelInterface $model): bool
    {
        return 1;
    }

    /**
     * 更新
     * @return int 更新的行数
     */
    public function update(ModelInterface $model): int
    {
        return 1;
    }
}

改写增删改查示例

<?php

namespace App\Http\Controllers;

use App\Models\Test\DB;
use App\Models\Test\Order;
use App\Models\Test\User;
use Symfony\Component\HttpFoundation\Response;

class TestController extends Controller
{
    /**
     * 查询示例
     * @return Response
     */
    public function index(): Response
    {
        $admin = User::make();
        DB::make(User::class)->where('username', '=', 'admin')->find($admin);
        $users = User::makes();
        DB::make(User::class)->where('nickname', 'like', "%$admin->nickname%")->get($users);
        $ret = [];
        foreach ($users as $user) {
            $tmp = [
                'username' => $user->username,
                'nickname' => $user->nickname,
                'avatar' => $user->avatar
            ];
            $order = new Order;
            $ok = DB::make(Order::class)->where('user_id', '=', $user->userId)->find($order);
            if ($ok && $order->status = Order::STATUS_SUCCESS) {
                $tmp['order'] = $order->toArray();
            } else {
                $tmp['order'] = null;
            }
            $ret[] = $tmp;
        }
        return $this->success($ret);
    }

    /**
     * 新增示例
     * @return Response
     */
    public function create(): Response
    {
        $user = new User();
        $user->username = 'test';
        $user->nickname = 'test';
        $user->avatar = 'test';
        return DB::make(User::class)->create($user) ? $this->success() : $this->error('新增失败', 1);
    }

    /**
     * 删除示例
     * @return Response
     */
    public function delete(): Response
    {
        $ok = DB::make(Order::class)->where('user_id', '=', 1)->delete();
        return $ok ? $this->success() : $this->error('删除失败', 1);
    }

    /**
     * 更新示例
     * @return Response
     */
    public function update(): Response
    {
        $user = new User();
        $user->username = 'test';
        $ok = DB::make(User::class)->where('userId', '=', 1)->update($user);
        return $ok ? $this->success() : $this->error('更新失败', 1);
    }
}
本作品采用《CC 协议》，转载必须注明作者和本文链接
梦想星辰大海
202 声望
划水师 @ 未来科技
暂无个人描述~
讨论数量: 5
排序：
时间 投票
springlee
课程读者 74 声望 / php @ zlj

你说的方案不是很好，你用idea-help+laravel idea 能实现你的编辑器能够点击跳转的代码

/**
 * @method static static updateOrCreate(array $attributes, array $values = [])
 * @method static static|null find(string|int $id, $columns = ['*'])
 * @method static static create(array $attributes = [])
 * @method static Collection<static> all($columns = ['*'])
 * @method static static|Builder query()
 */
class BaseModel extends Model 
{

}


/**
 * @mixin IdeHelperOrder
 */
class BaseModel extends Model
{
    protected static string $connection = 'test_db';
    protected static string $table = 'order';

}
3周前 评论
梦想星辰大海 （楼主） 2周前
点击跳转没问题，但是有提示噪音，除了提示模型本身的属性数据，还提示了orm的方法和查询构造器的方法。
浮心
课程读者 64 声望

我想你可能在找这个
github.com/spatie/data-transfer-ob...

2周前 评论
Rache1
683 声望

你这个轮子设计的真别扭，而且不完整，我就暂且按照你这里面的例子来说一下吧，你的需求，使用泛型注释就可以很简单的实现。

但是我没看懂，你的 DB 的 find/get 为什么需要传模型进去，然后返回一个 bool 值？

直接参考一下主流的设计，Laravel 那样，找到了返回模型，找不到返回 null 不就好了吗

其次就是 create 和 delete，同样的道理，我觉得你应该去参考一下已有的模型的做法。

如果是已知模型，那他就必定要有主键，然后你的 delete 就应该放在模型上，而不是在 DB 上。

对于根据条件删除的模型，那你才需要在 DB 上使用 delete，根据 where 来生成 delete，既然这样那传模型进来也没有啥意义呀。

当然，如果你说你为了更好的解耦的话，模型里面执行语句查询，那倒是可以考虑在 DB 的 delete 接收一个有主键的模型，这样在 delete 里面根据主键去删除。

最后就是你这个 update 方法，按照你的例子里面，你只设置了 username 属性，那其他属性呢？更新为空？还是不更新？你能区分的出来吗，现在。

那好，你说没关系，我们有反射，可以在反射里面判断，如果一个属性没有被初始化（赋值），那就认为这一个属性不会被更新。

但是……默认值呢？

那再用反射判断一下这个属性有没有默认值，那……要更新的值跟默认值一样呢？要不要更？

当然，这肯定是能实现的，比如在以前，你可以在 make 实例后，为对象创建一个快照，然后 update 的时候，比较比较之前的快照，update 后更新快照

而在 8.4 以后，你可以用 property hooks 来记录修改，但也要注意时机。

虽然把属性设置成 private 就可以轻松实现，但是一般编辑器都会显示一个错误在那里，就会有些难受了。

下面是使用泛型注释改造后的代码，开发工具可以正确识别出，get/find 的返回值的类型，并且可以正确的跳转/提示

file

<?php


namespace App\Models;

interface ModelInterface
{
    public static function getConnection(): string;

    public static function getTable(): string;

    /**
     * @return static
     */
    public static function make(array $attributes): static;

    public function toArray(): array;
}

use ReflectionClass;
use ReflectionProperty;

class  Model implements ModelInterface
{
    protected static string $connection = '';
    protected static string $table = '';

    public static function make(array $attributes): static
    {
        $model = new static();

        foreach ($attributes as $attribute => $value) {
            if (property_exists($model, $attribute)) {
                // 还要检查一些东西，避免字段和属性名字重复被覆盖了
                $model->{$attribute} = $value;
            }
        }

        return $model;
    }

    public static function getConnection(): string
    {
        return static::$connection;
    }

    public static function getTable(): string
    {
        return static::$table;
    }

    public function toArray(): array
    {
        //反射子类，并遍历子类的属性
        $reflection = new ReflectionClass($this);
        $properties = $reflection->getProperties(ReflectionProperty::IS_PUBLIC);
        $data = [];
        foreach ($properties as $property) {
            $propertyName = $property->getName();
            $data[$propertyName] = $this->$propertyName;
        }

        return $data;
    }

}


class  User extends Model
{
    protected static string $connection = 'test_db';
    protected static string $table = 'user';
    #[PrimaryKey]
    public int $userId = 0;
    public string $username = '';
    public string $password = '';
    public string $nickname = '';
    public string $avatar = '';
}


/**
 * @template TModel of ModelInterface
 */
class DB
{
    protected string $connection = '';
    protected string $table = '';
    /**
     * @var class-string<TModel>
     */
    protected string|ModelInterface $model = '';

    /**
     * 查询条件
     *
     * @param string $column 查询列
     * @param string|null $operator 查询操作符
     * @param mixed|null $value 查询值
     * @param string $boolean 查询条件连接符
     *
     * @return $this
     */
    public function where(string $column, string|null $operator = null, mixed $value = null, string $boolean = 'and'): static
    {
        return $this;
    }

    /**
     * 获取列表
     *
     * @param array<TModel> $models
     */
    public function get(): array
    {
        $models = [];
        // TODO list 是从 db 中查询的结果
        foreach ($list as $row) {
            $models[] = $this->model::make($row);
        }

        return $models;
    }

    /**
     * @template TModel of ModelInterface
     *
     * @param class-string<TModel> $model
     *
     * @return static<TModel>
     */
    public static function make(string $model): static
    {
        $ret = new static;
        $ret->model = $model;

        return $ret;
    }

    /**
     * 获取第一个
     *
     *
     * @return TModel
     */
    public function find(): ?ModelInterface
    {
        // TODO $attributes 可以通过前面记录的 where 最终查询数据获取得到，这里相当于模型要实现构造方法，接收从数据库查询得的结果
        return $this->model::make($attributes);
    }

    /**
     * 删除
     *
     * @return int 删除的行数
     */
    public function delete(): int
    {
        return 1;
    }

    /**
     * 创建
     *
     * @param TModel $model
     *
     * @return bool 创建成功或失败
     */
    public function create(ModelInterface $model): bool
    {
        return 1;
    }

    /**
     * 更新
     *
     * @param TModel $model
     *
     * @return int 更新的行数
     */
    public function update(ModelInterface $model): int
    {
        return 1;
    }
}


$user = DB::make(\App\Models\User::class)->where('user_id','=',1)->find();

$id = $user->userId;
2周前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！
支持 MD 帮助
梦想星辰大海
划水师 @ 未来科技
文章
24
粉丝
8
喜欢
43
收藏
46
排名：936
访问：6471
私信
所有博文
文章归档
1 篇 2025 年 9 月 1 篇 2024 年 11 月 2 篇 2024 年 8 月 1 篇 2024 年 5 月 1 篇 2024 年 4 月 1 篇 2023 年 12 月 3 篇 2023 年 9 月 2 篇 2023 年 8 月 1 篇 2023 年 6 月 1 篇 2023 年 5 月 1 篇 2023 年 3 月 1 篇 2022 年 11 月 1 篇 2022 年 10 月 2 篇 2022 年 9 月 1 篇 2022 年 8 月 1 篇 2022 年 6 月 1 篇 2022 年 5 月 1 篇 2022 年 4 月 1 篇 2020 年 7 月
最新文章 最受欢迎
3周前 php强类型编码下的db操作类设计思考 10个月前 解决workerman的gateway的崩溃问题 1年前 IOS16以下的系统，格式化日期转时间戳错误 1年前 在laravel下实现全双工的websocket开发 1年前 sql连表优化心得
21 在laravel下实现全双工的websocket开发 7 聊天表设计 4 sql连表优化心得 2 请求腾讯服务报错：Operation timed out 2 解决workerman的gateway的崩溃问题
博客标签
framework
1
 web
1
 sql
2
 websocket
2
 golang
2
社区赞助商
成为赞助商

关于 LearnKu

LearnKu 是终身编程者的修道场
做最专业、严肃的技术论坛
LearnKu 诞生的故事

资源推荐

  • 《社区使用指南》
  • 《文档撰写指南》
  • 《LearnKu 社区规范》
  • 《提问的智慧》

    • 服务提供商

    其他信息

  • 成为版主
  • 所有测验
  • 联系站长（反馈建议）

    • 粤ICP备18099781号-6 | 粤公网安备 44030502004330号 | 违法和不良信息举报

    由 Summer 设计和编码 | 方长科技协力运营

    请登录

    内容举报
    匿名举报，为防止滥用，仅管理员可见举报者。

    我要举报该，理由是：

    取消