如何缓存 auth()->user() 与 Laravel 缓存中的角色关系，以减少对数据库的调用？

Posted 2023-03-08

【中文标题】如何缓存 auth()->user() 与 Laravel 缓存中的角色关系，以减少对数据库的调用？

【英文标题】：How to cache auth()->user() with relationship like role in Laravel cache to reduce calls to DB?

【发布时间】：2021-09-15 03:18:02

【问题描述】：

我正在构建一个使用lighthouse-php 的应用程序。因为我不断地为不同的用户设置各种策略，所以我不断地在不同的部分应用程序中查询具有角色关系的用户模型，因此希望将用户存储在 Redis 数据库中并从那里查询。 我阅读了我在互联网上找到的几篇文章，例如：laravel-cache-authuser； creating-a-caching-user-provider-for-laravel/; caching-the-laravel-user-provider-with-a-decorator/，在这里查看代码 laravel-auth-user，有点理解这个概念，但很难深入理解 laravel 以找到合适的解决方案......

例如，我很难理解如何在 UserObserver 的事件方法中存储 User 和 Role 关系，很清楚如何使用一个模型而不是附加关系。

我有一种感觉，我应该这样做：

class UserObserver

    /**
     * @param User $user
     */
    public function saved(User $user)
    
        $user->load('role');
        Cache::put("user.$user->id", $user, 60);
    

但是通过这种方式，我对数据库进行了 2 次调用，而不是预先加载了关系。我如何在事件参数中预加载关系。我尝试添加 protected $with = ['role'] 以便始终加载子模型/关系。但无论我对 DB 进行更多调用以检索角色或检索用户和角色。

他是我项目lighthouse-php的一些简化代码示例。

schema.graphql：

type SomeType 
    someMethod(args: [String!]): [Model!] @method @can(ability: "isAdmin",  model: "App\\Models\\User")


type User 
    id: ID
    name: String
    role: Role @belongsTo


type Role 
    id: ID!
    name: String!
    label: String!
    users: [User!] @hasMany

具有角色关系的用户模型：

class User extends Authenticatabl 
    public function role(): BelongsTo
    
        return $this->belongsTo(Role::class);
    

用于某些 graphql 类型字段的用户策略：

class UserPolicy

    use HandlesAuthorization;

    public function isAdmin(): Response
    
        $user = auth()->user();

        return $user->role->name === 'admin'
            ? $this->allow()
            : $this->deny('permission denied');
    

    public function isManager(): Response
    
        $user = auth()->user();
        $this->allow();

        return $user->role->name === 'manager' || $user->role->name === 'admin'
            ? $this->allow()
            : $this->deny('Permission Denied');
    

用于通过方法解析字段的 Lighouse 自定义查询类。

class SomeType 
    public function someMethod(): string
    
       // this triggers db call rather than receiving `role->name` from redis along with user
       return auth()->user()->role->name;
    

如果我进行类似这样的 graphql 查询（请参见下文），它会导致从 db 加载角色关系，而不是从缓存中加载。

query 
   user 
     id
     name
     role 
       id
       name
     
   

Please help.

【参考方案1】：

您可以使用 Session 将您的身份验证用户与您的关系存储起来。

示例：

$auth = Auth::User();
Session::put('user',$auth);

Session::put('relation',$auth->relation);

希望对你有帮助

【讨论】：

是的，但是，我正在尝试将整个对象存储在具有关系的模型中

【参考方案2】：

您可以通过为User 模型上的role 属性创建自定义accessor 来缓存关系。一个例子可能是：

<?php 

use Illuminate\Support\Facades\Cache; 

class User extends Authenticatabl 

    public function role(): BelongsTo
    
        return $this->belongsTo(Role::class);
    

    public static function getRoleCacheKey(User $user): string
    
        return sprintf('user-%d-role', $user->id);
    

    // Define accessor for caching purposes
    public function getRoleAttribute(): Collection
    
        if ($this->relationLoaded('role')) 
            return $this->getRelationValue('role');
        
        
        // Replace 3600 for the amount of seconds you would like to cache
        $role = Cache::remember(User::getRoleCacheKey($this), 3600, function () 
            return $this->getRelationValue('role');
        );

        $this->setRelation('role', $role);

        return $role;
    

或者，您可以使用rememberForever() 函数将其永久缓存。请注意，您必须编写一个实现来手动删除/更新缓存，因为它将永远保存该值。您可以像这样创建一个清除缓存的函数：

// In User model
public static function forgetRoleCaching(User $user): bool

    return Cache::forget(sprintf(User::getRoleCacheKey($user));

您在观察者中的代码可以更新为以下内容：

class UserObserver

    /**
     * @param User $user
     */
    public function saved(User $user)
    
        // in case user role is cached forever
        User::forgetRoleCaching($user);

        $user->load('role'); // will trigger the accessor an should cache again
        Cache::put("user.$user->id", $user, 60);