add product manager
This commit is contained in:
@@ -0,0 +1,160 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Controller;
|
||||
|
||||
use Hyperf\Database\Model\Builder;
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
|
||||
/**
|
||||
* 数据实体 Controller 基类
|
||||
*
|
||||
* 封装通用的列表分页/筛选/字段选择/DataScope 逻辑，
|
||||
* 子类仅需定义字段集、筛选规则和 Model 类即可获得完整的列表+详情能力。
|
||||
*/
|
||||
abstract class AbstractDataController extends AbstractController
|
||||
{
|
||||
/** 实体模型类名 */
|
||||
abstract protected function getModelClass(): string;
|
||||
|
||||
/** 列表返回字段 */
|
||||
abstract protected function getListFields(): array;
|
||||
|
||||
/** 详情返回字段 */
|
||||
abstract protected function getDetailFields(): array;
|
||||
|
||||
/** 允许的筛选参数 => 筛选方式（exact/like/date_from/date_to） */
|
||||
abstract protected function getAllowedFilters(): array;
|
||||
|
||||
/** 默认排序字段 */
|
||||
protected function getDefaultSort(): string
|
||||
{
|
||||
return 'created_at';
|
||||
}
|
||||
|
||||
/** 默认排序方向 */
|
||||
protected function getDefaultSortDirection(): string
|
||||
{
|
||||
return 'desc';
|
||||
}
|
||||
|
||||
/**
|
||||
* 通用列表方法：分页 + 筛选 + DataScope + 字段选择
|
||||
*/
|
||||
public function index(): ResponseInterface|array
|
||||
{
|
||||
$model_class = $this->getModelClass();
|
||||
$query = $model_class::query()->select($this->getListFields());
|
||||
|
||||
// DataScope 过滤
|
||||
$this->applyDataScope($query);
|
||||
|
||||
// 应用筛选条件
|
||||
$this->applyFilters($query);
|
||||
|
||||
// 排序
|
||||
$query->orderBy($this->getDefaultSort(), $this->getDefaultSortDirection());
|
||||
|
||||
// 分页
|
||||
$per_page = min((int) ($this->request->input('per_page', 15)), 100);
|
||||
$per_page = max($per_page, 1);
|
||||
$page = max((int) ($this->request->input('page', 1)), 1);
|
||||
|
||||
$total = $query->count();
|
||||
$items = $query->offset(($page - 1) * $per_page)
|
||||
->limit($per_page)
|
||||
->get();
|
||||
|
||||
return [
|
||||
'code' => 0,
|
||||
'message' => '获取成功',
|
||||
'data' => [
|
||||
'items' => $items,
|
||||
'total' => $total,
|
||||
'page' => $page,
|
||||
'per_page' => $per_page,
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* 通用详情方法：字段选择 + DataScope 校验
|
||||
*/
|
||||
public function show(int $id): ResponseInterface|array
|
||||
{
|
||||
$model_class = $this->getModelClass();
|
||||
$fields = $this->getDetailFields();
|
||||
|
||||
$query = $model_class::query();
|
||||
if ($fields !== ['*']) {
|
||||
$query->select($fields);
|
||||
}
|
||||
|
||||
// DataScope 过滤（确保只能查看权限范围内的数据）
|
||||
$this->applyDataScope($query);
|
||||
|
||||
$record = $query->where('id', $id)->first();
|
||||
|
||||
if (!$record) {
|
||||
return $this->response->json([
|
||||
'code' => 404,
|
||||
'message' => '数据不存在',
|
||||
])->withStatus(404);
|
||||
}
|
||||
|
||||
return [
|
||||
'code' => 0,
|
||||
'message' => '获取成功',
|
||||
'data' => $record,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* 应用 DataScope 过滤
|
||||
*
|
||||
* 读取 PermissionMiddleware 注入的 scope_type / scope_ids 属性，
|
||||
* 自动添加 WHERE 条件限制查询范围。
|
||||
*/
|
||||
protected function applyDataScope(Builder $query): void
|
||||
{
|
||||
$scope_type = $this->request->getAttribute('scope_type');
|
||||
$scope_ids = $this->request->getAttribute('scope_ids', []);
|
||||
|
||||
if ($scope_type === 'store') {
|
||||
$query->whereIn('store_id', $scope_ids);
|
||||
} elseif ($scope_type === 'platform') {
|
||||
$query->whereIn('platform_id', $scope_ids);
|
||||
}
|
||||
// 'all' → 不附加条件
|
||||
}
|
||||
|
||||
/**
|
||||
* 应用筛选条件
|
||||
*
|
||||
* 根据 getAllowedFilters() 定义的参数名和筛选方式，
|
||||
* 从请求参数中提取值并构建 WHERE 子句。
|
||||
*
|
||||
* 支持的筛选方式：
|
||||
* - exact: 精确匹配（WHERE col = value）
|
||||
* - like: 模糊搜索（WHERE col ILIKE %value%）
|
||||
* - date_from: 日期下界（WHERE col >= value），参数名需以 _from 结尾
|
||||
* - date_to: 日期上界（WHERE col <= value 23:59:59），参数名需以 _to 结尾
|
||||
*/
|
||||
protected function applyFilters(Builder $query): void
|
||||
{
|
||||
foreach ($this->getAllowedFilters() as $param => $type) {
|
||||
$value = $this->request->input($param);
|
||||
if ($value === null || $value === '') {
|
||||
continue;
|
||||
}
|
||||
|
||||
match ($type) {
|
||||
'exact' => $query->where($param, $value),
|
||||
'like' => $query->where($param, 'ilike', "%{$value}%"),
|
||||
'date_from' => $query->where(str_replace('_from', '', $param), '>=', $value),
|
||||
'date_to' => $query->where(str_replace('_to', '', $param), '<=', $value . ' 23:59:59'),
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,146 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Controller\Api\V1;
|
||||
|
||||
use App\Controller\AbstractDataController;
|
||||
use App\Middleware\AuthMiddleware;
|
||||
use App\Middleware\PermissionMiddleware;
|
||||
use App\Model\Product;
|
||||
use Hyperf\HttpServer\Annotation\Controller;
|
||||
use Hyperf\HttpServer\Annotation\Middleware;
|
||||
use Hyperf\HttpServer\Annotation\RequestMapping;
|
||||
use OpenApi\Attributes as OA;
|
||||
|
||||
/**
|
||||
* 产品管理接口（Normal Category）
|
||||
*
|
||||
* 返回所有 parsed 字段，不含 raw/hash
|
||||
*/
|
||||
#[OA\Tag(name: 'Products', description: '产品管理')]
|
||||
#[Controller(prefix: "/api/v1/products")]
|
||||
#[Middleware(AuthMiddleware::class)]
|
||||
#[Middleware(PermissionMiddleware::class)]
|
||||
class ProductController extends AbstractDataController
|
||||
{
|
||||
protected function getModelClass(): string
|
||||
{
|
||||
return Product::class;
|
||||
}
|
||||
|
||||
protected function getListFields(): array
|
||||
{
|
||||
return [
|
||||
'id', 'company_id', 'platform_id', 'store_id', 'status_id',
|
||||
'platform_item_id', 'platform_model_id', 'name', 'price',
|
||||
'currency', 'num', 'created_date', 'updated_date',
|
||||
];
|
||||
}
|
||||
|
||||
protected function getDetailFields(): array
|
||||
{
|
||||
return [
|
||||
'id', 'company_id', 'platform_id', 'store_id', 'status_id',
|
||||
'type_id', 'platform_item_id', 'platform_model_id',
|
||||
'origin_sku_id', 'mapped_sku_id', 'barcode', 'hscode',
|
||||
'bundled', 'name', 'url', 'picture', 'price', 'currency',
|
||||
'num', 'warehouse_id', 'sub_warehouse_id', 'ext',
|
||||
'created_date', 'updated_date', 'created_at', 'updated_at',
|
||||
];
|
||||
}
|
||||
|
||||
protected function getAllowedFilters(): array
|
||||
{
|
||||
return [
|
||||
'company_id' => 'exact',
|
||||
'platform_id' => 'exact',
|
||||
'store_id' => 'exact',
|
||||
'status_id' => 'exact',
|
||||
'platform_item_id' => 'exact',
|
||||
'name' => 'like',
|
||||
];
|
||||
}
|
||||
|
||||
protected function getDefaultSort(): string
|
||||
{
|
||||
return 'updated_date';
|
||||
}
|
||||
|
||||
/**
|
||||
* 产品列表
|
||||
*/
|
||||
#[OA\Get(
|
||||
path: '/products',
|
||||
summary: '产品列表',
|
||||
description: '获取产品列表，支持分页、多维度筛选。返回业务字段，不含 raw/hash。',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['Products'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'page', in: 'query', required: false, schema: new OA\Schema(type: 'integer', default: 1)),
|
||||
new OA\Parameter(name: 'per_page', in: 'query', required: false, schema: new OA\Schema(type: 'integer', default: 15, maximum: 100)),
|
||||
new OA\Parameter(name: 'company_id', in: 'query', required: false, description: '公司 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'platform_id', in: 'query', required: false, description: '平台 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'store_id', in: 'query', required: false, description: '店铺 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'status_id', in: 'query', required: false, description: '产品状态 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'platform_item_id', in: 'query', required: false, description: '平台商品 ID 精确搜索', schema: new OA\Schema(type: 'string')),
|
||||
new OA\Parameter(name: 'name', in: 'query', required: false, description: '商品名称模糊搜索', schema: new OA\Schema(type: 'string')),
|
||||
],
|
||||
responses: [
|
||||
new OA\Response(
|
||||
response: 200,
|
||||
description: '获取成功',
|
||||
content: new OA\JsonContent(properties: [
|
||||
new OA\Property(property: 'code', type: 'integer', example: 0),
|
||||
new OA\Property(property: 'message', type: 'string', example: '获取成功'),
|
||||
new OA\Property(property: 'data', properties: [
|
||||
new OA\Property(property: 'items', type: 'array', items: new OA\Items(ref: '#/components/schemas/Product')),
|
||||
new OA\Property(property: 'total', type: 'integer', example: 100),
|
||||
new OA\Property(property: 'page', type: 'integer', example: 1),
|
||||
new OA\Property(property: 'per_page', type: 'integer', example: 15),
|
||||
], type: 'object'),
|
||||
])
|
||||
),
|
||||
new OA\Response(response: 401, description: '未认证', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 403, description: '无权限', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
]
|
||||
)]
|
||||
#[RequestMapping(path: "", methods: "GET")]
|
||||
public function index(): \Psr\Http\Message\ResponseInterface|array
|
||||
{
|
||||
return parent::index();
|
||||
}
|
||||
|
||||
/**
|
||||
* 产品详情
|
||||
*/
|
||||
#[OA\Get(
|
||||
path: '/products/{id}',
|
||||
summary: '产品详情',
|
||||
description: '获取产品详情，返回所有业务字段和 ext，不含 raw/hash。',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['Products'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'id', in: 'path', required: true, description: '产品 ID', schema: new OA\Schema(type: 'integer')),
|
||||
],
|
||||
responses: [
|
||||
new OA\Response(
|
||||
response: 200,
|
||||
description: '获取成功',
|
||||
content: new OA\JsonContent(properties: [
|
||||
new OA\Property(property: 'code', type: 'integer', example: 0),
|
||||
new OA\Property(property: 'message', type: 'string', example: '获取成功'),
|
||||
new OA\Property(property: 'data', ref: '#/components/schemas/Product'),
|
||||
])
|
||||
),
|
||||
new OA\Response(response: 401, description: '未认证', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 403, description: '无权限', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 404, description: '数据不存在', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
]
|
||||
)]
|
||||
#[RequestMapping(path: "{id}", methods: "GET")]
|
||||
public function show(int $id): \Psr\Http\Message\ResponseInterface|array
|
||||
{
|
||||
return parent::show($id);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,146 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Controller\Api\V1;
|
||||
|
||||
use App\Middleware\AuthMiddleware;
|
||||
use App\Middleware\PermissionMiddleware;
|
||||
use Hyperf\HttpServer\Annotation\Controller;
|
||||
use Hyperf\HttpServer\Annotation\Middleware;
|
||||
use Hyperf\HttpServer\Annotation\RequestMapping;
|
||||
use OpenApi\Attributes as OA;
|
||||
|
||||
/**
|
||||
* 产品管理接口（Raw Category）
|
||||
*
|
||||
* 返回关键标识 + raw + hash，供开发/调试查看原始平台数据。
|
||||
* 列表不返回 raw 字段（单条 JSONB 可达数十 KB），仅返回 hash。
|
||||
* 详情返回完整 raw。
|
||||
*/
|
||||
#[OA\Tag(name: 'Products (Raw)', description: '产品原始数据')]
|
||||
#[Controller(prefix: "/api/v1/raw/products")]
|
||||
#[Middleware(AuthMiddleware::class)]
|
||||
#[Middleware(PermissionMiddleware::class)]
|
||||
class RawProductController extends ProductController
|
||||
{
|
||||
protected function getListFields(): array
|
||||
{
|
||||
return [
|
||||
'id', 'platform_item_id', 'platform_model_id', 'name',
|
||||
'store_id', 'company_id', 'platform_id', 'hash',
|
||||
'updated_date', 'updated_at',
|
||||
];
|
||||
}
|
||||
|
||||
protected function getDetailFields(): array
|
||||
{
|
||||
return [
|
||||
'id', 'platform_item_id', 'platform_model_id', 'name',
|
||||
'store_id', 'company_id', 'platform_id',
|
||||
'raw', 'hash', 'ext',
|
||||
'created_date', 'updated_date',
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* 产品列表（Raw）
|
||||
*/
|
||||
#[OA\Get(
|
||||
path: '/raw/products',
|
||||
summary: '产品列表（Raw）',
|
||||
description: '获取产品原始数据列表。返回关键标识 + hash，不含 raw 字段本身（太大）。筛选参数与 Normal 接口一致。',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['Products (Raw)'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'page', in: 'query', required: false, schema: new OA\Schema(type: 'integer', default: 1)),
|
||||
new OA\Parameter(name: 'per_page', in: 'query', required: false, schema: new OA\Schema(type: 'integer', default: 15, maximum: 100)),
|
||||
new OA\Parameter(name: 'company_id', in: 'query', required: false, description: '公司 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'platform_id', in: 'query', required: false, description: '平台 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'store_id', in: 'query', required: false, description: '店铺 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'status_id', in: 'query', required: false, description: '产品状态 ID 精确筛选', schema: new OA\Schema(type: 'integer')),
|
||||
new OA\Parameter(name: 'platform_item_id', in: 'query', required: false, description: '平台商品 ID 精确搜索', schema: new OA\Schema(type: 'string')),
|
||||
new OA\Parameter(name: 'name', in: 'query', required: false, description: '商品名称模糊搜索', schema: new OA\Schema(type: 'string')),
|
||||
],
|
||||
responses: [
|
||||
new OA\Response(
|
||||
response: 200,
|
||||
description: '获取成功',
|
||||
content: new OA\JsonContent(properties: [
|
||||
new OA\Property(property: 'code', type: 'integer', example: 0),
|
||||
new OA\Property(property: 'message', type: 'string', example: '获取成功'),
|
||||
new OA\Property(property: 'data', properties: [
|
||||
new OA\Property(property: 'items', type: 'array', items: new OA\Items(properties: [
|
||||
new OA\Property(property: 'id', type: 'integer'),
|
||||
new OA\Property(property: 'platform_item_id', type: 'string'),
|
||||
new OA\Property(property: 'platform_model_id', type: 'string', nullable: true),
|
||||
new OA\Property(property: 'name', type: 'string', nullable: true),
|
||||
new OA\Property(property: 'store_id', type: 'integer'),
|
||||
new OA\Property(property: 'company_id', type: 'integer'),
|
||||
new OA\Property(property: 'platform_id', type: 'integer'),
|
||||
new OA\Property(property: 'hash', type: 'string'),
|
||||
new OA\Property(property: 'updated_date', type: 'string', format: 'date-time', nullable: true),
|
||||
new OA\Property(property: 'updated_at', type: 'string', format: 'date-time'),
|
||||
], type: 'object')),
|
||||
new OA\Property(property: 'total', type: 'integer'),
|
||||
new OA\Property(property: 'page', type: 'integer'),
|
||||
new OA\Property(property: 'per_page', type: 'integer'),
|
||||
], type: 'object'),
|
||||
])
|
||||
),
|
||||
new OA\Response(response: 401, description: '未认证', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 403, description: '无权限', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
]
|
||||
)]
|
||||
#[RequestMapping(path: "", methods: "GET")]
|
||||
public function index(): \Psr\Http\Message\ResponseInterface|array
|
||||
{
|
||||
return parent::index();
|
||||
}
|
||||
|
||||
/**
|
||||
* 产品详情（Raw）
|
||||
*/
|
||||
#[OA\Get(
|
||||
path: '/raw/products/{id}',
|
||||
summary: '产品详情（Raw）',
|
||||
description: '获取产品原始数据详情。返回关键标识 + 完整 raw + hash + ext。',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['Products (Raw)'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'id', in: 'path', required: true, description: '产品 ID', schema: new OA\Schema(type: 'integer')),
|
||||
],
|
||||
responses: [
|
||||
new OA\Response(
|
||||
response: 200,
|
||||
description: '获取成功',
|
||||
content: new OA\JsonContent(properties: [
|
||||
new OA\Property(property: 'code', type: 'integer', example: 0),
|
||||
new OA\Property(property: 'message', type: 'string', example: '获取成功'),
|
||||
new OA\Property(property: 'data', properties: [
|
||||
new OA\Property(property: 'id', type: 'integer'),
|
||||
new OA\Property(property: 'platform_item_id', type: 'string'),
|
||||
new OA\Property(property: 'platform_model_id', type: 'string', nullable: true),
|
||||
new OA\Property(property: 'name', type: 'string', nullable: true),
|
||||
new OA\Property(property: 'store_id', type: 'integer'),
|
||||
new OA\Property(property: 'company_id', type: 'integer'),
|
||||
new OA\Property(property: 'platform_id', type: 'integer'),
|
||||
new OA\Property(property: 'raw', type: 'object', description: '平台原始数据'),
|
||||
new OA\Property(property: 'hash', type: 'string'),
|
||||
new OA\Property(property: 'ext', type: 'object', nullable: true),
|
||||
new OA\Property(property: 'created_date', type: 'string', format: 'date-time', nullable: true),
|
||||
new OA\Property(property: 'updated_date', type: 'string', format: 'date-time', nullable: true),
|
||||
], type: 'object'),
|
||||
])
|
||||
),
|
||||
new OA\Response(response: 401, description: '未认证', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 403, description: '无权限', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
new OA\Response(response: 404, description: '数据不存在', content: new OA\JsonContent(ref: '#/components/schemas/ErrorResponse')),
|
||||
]
|
||||
)]
|
||||
#[RequestMapping(path: "{id}", methods: "GET")]
|
||||
public function show(int $id): \Psr\Http\Message\ResponseInterface|array
|
||||
{
|
||||
return parent::show($id);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user