Laravel模型隐藏关系？关系如何隐藏排除？-Laravel-PHP中文网

Laravel模型隐藏关系需区分“不显示”与“不加载”：通过$hidden属性全局隐藏序列化输出中的关系；使用makeHidden()和makeVisible()动态控制特定场景下的关系显示；利用without()方法在查询时避免加载无关关联数据以提升性能。

laravel模型隐藏关系？关系如何隐藏排除？

Laravel模型隐藏关系，核心在于控制模型在序列化为数组或JSON时哪些数据被暴露，以及在查询时哪些关联数据不被加载。这通常通过在模型中定义

$hidden

登录后复制

属性来全局性地排除特定字段或关系，或者使用

makeHidden()

登录后复制

方法在运行时动态隐藏。对于避免加载不必要的关联数据以提升性能，则需要用到

without()

登录后复制

等方法。

解决方案

在Laravel中处理模型关系的隐藏与排除，我们通常会从两个主要维度入手：一是控制模型在转换为数组或JSON时的可见性，二是控制数据库查询时是否加载这些关系。

全局默认隐藏关系（序列化层面）： 你可以在模型中定义
```
$hidden
```
登录后复制
属性，这是一个数组，包含所有你希望在模型被序列化时默认隐藏的属性和关系名称。例如，如果你的
```
User
```
登录后复制
模型有一个
```
posts
```
登录后复制
关系（
```
hasMany(Post::class)
```
登录后复制
），并且你不希望每次序列化
```
User
```
登录后复制
时都带上
```
posts
```
登录后复制
数据，可以这样设置：
```
class User extends Model
{
    protected $hidden = [
        'password',
        'remember_token',
        'posts', // 隐藏posts关系
    ];

    public function posts()
    {
        return $this->hasMany(Post::class);
    }
}
```
登录后复制
这样，当你
```
User::find(1)->toJson()
```
登录后复制
或将其作为API响应返回时，
```
posts
```
登录后复制
关系就不会被包含在内。
运行时动态隐藏/显示关系（序列化层面）： 有时候，你可能需要在特定场景下才隐藏或显示某个关系。Laravel提供了
```
makeHidden()
```
登录后复制
和
```
makeVisible()
```
登录后复制
方法来实现这一点。
- makeHidden(array|string $attributes)
  登录后复制
  : 动态隐藏一个或多个属性或关系。
```
$user = User::find(1);
$user->load('posts'); // 先加载关系
return $user->makeHidden('posts')->toJson(); // 动态隐藏posts
```
  登录后复制
- makeVisible(array|string $attributes)
  登录后复制
  : 动态显示一个或多个属性或关系，这可以覆盖
```
$hidden
```
  登录后复制
  属性的设置。
```
// 假设posts在$hidden数组中
$user = User::find(1);
$user->load('posts');
return $user->makeVisible('posts')->toJson(); // 动态显示posts
```
  登录后复制
避免加载不必要的模型关系（查询层面）： 这与上述序列化层面的隐藏有所不同，它是在数据库查询阶段就阻止关联数据的加载，从而优化性能。
- without(array|string $relations)
  登录后复制
  : 在查询时明确告诉Laravel不要加载指定的关联关系。
```
$users = User::without('posts')->get(); // 查询User时，不加载posts关系
// 此时，$users中的每个User模型都不会有posts关联数据
```
  登录后复制
- with()
  登录后复制
  的精细控制：如果你通常使用
```
with()
```
  登录后复制
  进行预加载，但想在某些情况下排除，
```
without()
```
  登录后复制
  是更直接的选择。但如果你只是想预加载部分关系，而忽略其他，那直接在
```
with()
```
  登录后复制
  中指定即可。

理解这三点，基本上就能覆盖你在Laravel中处理模型关系隐藏与排除的绝大部分场景了。在我看来，区分“不加载”和“不显示”是关键，它们服务于不同的目的。

Laravel模型中如何全局默认排除关联数据？

我们开发应用时，常常会遇到一些关联数据，虽然它们在数据库层面是真实存在的，但在大部分API响应或者视图渲染中，我们并不希望它们默认出现。比如说，一个

User

登录后复制

模型可能关联了大量的

Order

登录后复制

数据，但当你在用户列表中展示用户信息时，并不需要每个用户都带上所有订单。这时候，将这些关系设置为全局默认排除就显得尤为重要，它不仅能让你的API响应更简洁，还能在一定程度上提升数据传输的效率。

要实现这一点，最直接且推荐的方式就是在你的Laravel模型中利用

$hidden

登录后复制

属性。这个属性是一个数组，你可以在其中列出任何你希望在模型被序列化（通常是转换为数组或JSON）时自动隐藏的属性或关联关系名称。

// app/Models/User.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;

class User extends Model
{
    /**
     * The attributes that should be hidden for serialization.
     *
     * @var array<int, string>
     */
    protected $hidden = [
        'password',
        'remember_token',
        'email_verified_at', // 也许这个字段也不想默认暴露
        'orders', // 假设User模型有一个orders关系
        'comments', // 假设User模型有一个comments关系
    ];

    /**
     * Get the orders for the user.
     */
    public function orders(): HasMany
    {
        return $this->hasMany(Order::class);
    }

    /**
     * Get the comments for the user.
     */
    public function comments(): HasMany
    {
        return $this->hasMany(Comment::class);
    }
}

登录后复制

在上面的例子中，当

User

登录后复制

模型实例被转换为数组或JSON时，

password

登录后复制

、

remember_token

登录后复制

、

email_verified_at

登录后复制

这些属性以及

orders

登录后复制

和

comments

登录后复制

这两个关系将不会被包含在输出中。这意味着，如果你执行

User::find(1)->toJson()

登录后复制

，你将看不到任何订单或评论数据，即使这些关系已经被加载（例如通过

User::find(1)->load('orders')

登录后复制

）。

我个人觉得，使用

$hidden

登录后复制

属性是管理模型输出可见性的一种非常优雅且集中的方式。它把默认行为固化在模型定义中，减少了在控制器或API资源中重复编写隐藏逻辑的麻烦。但需要注意的是，

$hidden

登录后复制

只影响序列化，它并不会阻止Laravel在需要时加载这些关系到内存中。如果你希望从一开始就避免加载关系以节省查询资源，那又是另一个话题了。

如何在特定场景下动态隐藏Laravel模型关系？

有时候，我们不能简单地将关系全局隐藏。比如，在一个后台管理系统中，管理员查看用户详情时可能需要看到所有关联订单，但在一个面向普通用户的API接口中，我们只希望返回用户的基本信息，不带任何订单数据。这时候，动态控制模型关系的可见性就显得尤为重要。Laravel提供了非常灵活的

makeHidden()

登录后复制

和

makeVisible()

登录后复制

方法来应对这种按需调整的场景。

百灵大模型

蚂蚁集团自研的多模态AI大模型系列

177

查看详情

makeHidden()

登录后复制

方法允许你在模型实例上临时隐藏一个或多个属性或关系。它的参数可以是一个字符串（单个属性/关系名）或一个数组（多个属性/关系名）。

// 场景一：API响应中，用户列表不显示订单
public function index(Request $request)
{
    $users = User::with('profile')->get(); // 加载profile，但不加载orders
    // 假设orders在$hidden中，但我们想确保即使不在$hidden中，这里也不显示
    $users->each(function ($user) {
        $user->makeHidden('orders'); // 即使orders没有被$hidden，这里也会隐藏
    });
    return response()->json($users);
}

// 场景二：用户详情页，根据权限显示或隐藏
public function show(User $user)
{
    $user->load('orders', 'posts'); // 预加载所有可能需要的关系

    if (!Auth::user()->can('view-sensitive-data')) {
        $user->makeHidden(['orders', 'posts']); // 如果没有权限，就隐藏
    }

    return response()->json($user);
}

登录后复制

与

makeHidden()

登录后复制

相对的是

makeVisible()

登录后复制

。这个方法的作用是临时覆盖模型

$hidden

登录后复制

属性的设置，让原本被隐藏的属性或关系变得可见。这在某些特定视图或API端点需要更多数据时非常有用。

// 假设User模型中的$hidden属性包含了'orders'
class User extends Model
{
    protected $hidden = [
        'password',
        'remember_token',
        'orders',
    ];
    // ...
}

// 在一个需要显示订单的API端点或视图中
public function adminShowUserOrders(User $user)
{
    $user->load('orders.items'); // 预加载订单及其明细
    $user->makeVisible('orders'); // 即使orders在$hidden中，这里也会显示出来

    return response()->json($user);
}

登录后复制

在我看来，

makeHidden()

登录后复制

和

makeVisible()

登录后复制

的强大之处在于它们的运行时灵活性。它们不会改变模型的全局配置，而是针对特定的模型实例生效。这使得我们能够根据用户角色、请求类型或者其他业务逻辑，精细地控制数据的暴露程度。这种方法特别适用于构建具有不同权限级别或多种API版本的应用。记住，这些方法同样只影响模型序列化时的输出，不影响关系的加载行为。如果关系没有被加载，即使你

makeVisible()

登录后复制

它，也不会有数据出现。

Laravel如何避免加载不必要的模型关系以提升性能？

我们都知道，N+1查询问题是Laravel开发中常见的性能陷阱。当你在循环中访问未预加载的关联关系时，Laravel会为每个模型执行一次额外的数据库查询，导致性能急剧下降。虽然

with()

登录后复制

方法可以很好地解决这个问题，但有时候，我们甚至不希望某些关系被加载到内存中，即使它们是可用的。这不仅仅是为了避免N+1，更是为了减少不必要的数据库查询、降低内存消耗，尤其是在处理大量数据或复杂查询时。

Laravel提供了

without()

登录后复制

方法，它允许你在查询构建器层面明确指定哪些关联关系不应该被加载。这与

$hidden

登录后复制

或

makeHidden()

登录后复制

的侧重点完全不同：后者是关于“显示什么”，而

without()

登录后复制

是关于“加载什么”。

// 场景一：获取用户列表，但明确不需要他们的订单和评论
$users = User::without(['orders', 'comments'])->get();

foreach ($users as $user) {
    // 此时，$user->orders 和 $user->comments 都将是 null
    // 访问它们也不会触发懒加载，因为Eloquent知道它们被明确排除了
    // 如果你尝试访问，Eloquent甚至可能抛出异常，提示关系未加载
    dump($user->orders); // 输出 null
}

// 场景二：在特定查询中，避免加载某个大型关系
$posts = Post::where('status', 'published')
             ->without('tags') // 假设tags关系数据量很大，当前查询不需要
             ->get();

登录后复制

通过使用