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

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 方法。
整个实现如下：

————————————————
原文作者：梦想星辰大海
转自链接：博客：php强类型编码下的db操作类设计思考
版权声明：著作权归作者所有。商业转载请联系作者获得授权，非商业转载请保留以上作者信息和原文链接。