PHPAPI字段选择怎么支持

wen PHP项目 2026-07-06 6

本文目录导读：

PHPAPI字段选择怎么支持

基本查询参数方式
使用中间件方案
Trait方式（推荐）
使用现有的库
API资源的字段选择
最佳实践建议

在PHP API中实现字段选择（Field Selection）功能,常见的实现方式有以下几种：

基本查询参数方式

实现方法

// 客户端请求
GET /api/users?fields=id,name,email
// 服务端处理
class UserController {
    public function index(Request $request) {
        $allowedFields = ['id', 'name', 'email', 'avatar', 'created_at'];
        $fields = $request->input('fields');
        if ($fields) {
            $fields = array_intersect(
                explode(',', $fields),
                $allowedFields
            );
        } else {
            $fields = $allowedFields; // 默认返回所有字段
        }
        $users = User::select($fields)->get();
        return response()->json($users);
    }
}

GraphQL风格字段选择

// 更灵活的字段选择
class FieldSelector {
    private $allowedFields = [];
    private $fieldAliases = [];
    public function parse(string $fields): array {
        $result = [];
        $parts = explode(',', $fields);
        foreach ($parts as $part) {
            $part = trim($part);
            // 支持嵌套字段：user(id,name,posts(title))
            if (strpos($part, '(') !== false) {
                preg_match('/(\w+)\((.+)\)/', $part, $matches);
                $result[$matches[1]] = $this->parse($matches[2]);
            } else {
                $result[$part] = true;
            }
        }
        return $result;
    }
    public function filter(array $data, array $fields): array {
        $result = [];
        foreach ($fields as $key => $value) {
            if ($value === true && isset($data[$key])) {
                $result[$key] = $data[$key];
            } elseif (is_array($value) && isset($data[$key])) {
                $result[$key] = $this->filter($data[$key], $value);
            }
        }
        return $result;
    }
}

使用中间件方案

// 中间件实现
class FieldSelectorMiddleware {
    public function handle($request, \Closure $next) {
        $response = $next($request);
        if ($fields = $request->input('fields')) {
            $data = $response->getData(true);
            if (isset($data['data'])) {
                $data['data'] = $this->filterFields($data['data'], $fields);
            }
            $response->setData($data);
        }
        return $response;
    }
    private function filterFields($data, $fields) {
        $allowedFields = explode(',', $fields);
        if (is_array($data)) {
            return array_map(function($item) use ($allowedFields) {
                if (is_array($item)) {
                    return array_intersect_key($item, array_flip($allowedFields));
                }
                return $item;
            }, $data);
        }
        return $data;
    }
}

Trait方式（推荐）

trait FieldSelectable {
    protected $defaultFields = [];
    protected $hiddenFields = [];
    protected $computedFields = [];
    public function scopeSelectFields($query, $fields = null) {
        if (!$fields) {
            $fields = $this->defaultFields;
        }
        $fields = $this->parseFields($fields);
        // 处理关联关系
        $relations = array_filter($fields, function($field) {
            return method_exists($this, $field);
        });
        if (!empty($relations)) {
            $query->with($relations);
        }
        // 选择数据库字段
        $dbFields = array_diff($fields, array_keys($this->computedFields), $relations);
        if (!empty($dbFields)) {
            $query->select($dbFields);
        }
        return $query;
    }
    public function toArrayWithFields($fields = null) {
        $data = $this->toArray();
        if ($fields) {
            $fields = $this->parseFields($fields);
            $data = array_intersect_key($data, array_flip($fields));
            // 添加计算字段
            foreach ($this->computedFields as $name => $callback) {
                if (in_array($name, $fields)) {
                    $data[$name] = $callback($this);
                }
            }
        }
        return $data;
    }
    private function parseFields($fields) {
        if (is_string($fields)) {
            return explode(',', $fields);
        }
        return (array) $fields;
    }
}
// 使用示例
class User extends Model {
    use FieldSelectable;
    protected $defaultFields = ['id', 'name', 'email'];
    protected $hiddenFields = ['password'];
    protected $computedFields = [
        'full_name' => function($user) {
            return $user->first_name . ' ' . $user->last_name;
        },
        'avatar_url' => function($user) {
            return $user->getAvatarUrl();
        }
    ];
}
// Controller中使用
class UserController extends Controller {
    public function index(Request $request) {
        $fields = $request->input('fields');
        $users = User::selectFields($fields)->get();
        return response()->json(
            $users->map->toArrayWithFields($fields)
        );
    }
}

使用现有的库

Spatie的laravel-query-builder

composer require spatie/laravel-query-builder

use Spatie\QueryBuilder\QueryBuilder;
class UserController extends Controller {
    public function index() {
        $users = QueryBuilder::for(User::class)
            ->allowedFields(['id', 'name', 'email', 'avatar.created_at'])
            ->get();
        return response()->json($users);
    }
}
// 客户端请求
GET /api/users?fields[users]=id,name,email&fields[avatar]=url

API资源的字段选择

class UserResource extends JsonResource {
    public function toArray($request) {
        $fields = $this->parseFields($request);
        $data = [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
        ];
        if ($fields) {
            return array_intersect_key($data, array_flip($fields));
        }
        return $data;
    }
    private function parseFields($request) {
        if ($fields = $request->input('fields')) {
            if (isset($fields['users'])) {
                return explode(',', $fields['users']);
            }
        }
        return null;
    }
}

最佳实践建议

安全考虑

// 始终验证字段白名单
$allowedFields = ['id', 'name', 'email'];
$requestedFields = explode(',', $request->input('fields', ''));
$validFields = array_intersect($requestedFields, $allowedFields);