Laravel 时间 (Laravel Appends)

在 Laravel 应用中，处理时间戳和日期格式是一个常见的需求。介绍如何使用 appends 属性来自动添加格式化的时间字段到模型的 JSON 响应中，并提供几种不同的实现思路。

解决方案

Laravel 的 Eloquent 模型提供了 appends 属性，可以用来自动添加自定义属性到模型的 JSON 响应中。通过这种方式，我们可以在模型中定义一个方法来格式化时间戳，并将其添加到 JSON 响应中，而无需在控制器中手动处理。

使用 appends 属性添加格式化时间

1. 定义自定义属性

我们需要在模型中定义一个自定义属性方法来格式化时间戳。假设我们有一个 User 模型，其中包含 created_at 和 updated_at 字段。

php
namespace AppModels;</p>

<p>use IlluminateDatabaseEloquentModel;</p>

<p>class User extends Model
{
    // 需要附加的属性
    protected $appends = ['formatted<em>created</em>at', 'formatted<em>updated</em>at'];</p>

<pre><code>// 格式化 created_at 字段
public function getFormattedCreatedAtAttribute()
{
    return $this->created_at->format('Y-m-d H:i:s');
}

// 格式化 updated_at 字段
public function getFormattedUpdatedAtAttribute()
{
    return $this->updated_at->format('Y-m-d H:i:s');
}

}

2. 在控制器中使用

在控制器中，我们可以直接返回模型的 JSON 响应，而不需要手动格式化时间戳。

php
namespace AppHttpControllers;</p>

<p>use AppModelsUser;
use IlluminateHttpRequest;</p>

<p>class UserController extends Controller
{
    public function show($id)
    {
        $user = User::find($id);
        return response()->json($user);
    }
}

3. 测试响应

访问 /api/users/{id} 路由时，返回的 JSON 响应将包含 formatted_created_at 和 formatted_updated_at 字段。

json
{
"id": 1,
"name": "John Doe",
"email": "john@example.com",
"created_at": "2023-10-01 12:00:00",
"updated_at": "2023-10-01 12:00:00",
"formatted_created_at": "2023-10-01 12:00:00",
"formatted_updated_at": "2023-10-01 12:00:00"
}


其他思路

使用 Accessors

Laravel 的 Accessors 是另一种方式来格式化模型属性。我们可以在模型中定义 Accessor 方法来格式化时间戳。

php
namespace AppModels;</p>

<p>use IlluminateDatabaseEloquentModel;</p>

<p>class User extends Model
{
    // 格式化 created<em>at 字段
    public function getFormattedCreatedAtAttribute()
    {
        return $this->created</em>at->format('Y-m-d H:i:s');
    }</p>

<pre><code>// 格式化 updated_at 字段
public function getFormattedUpdatedAtAttribute()
{
    return $this->updated_at->format('Y-m-d H:i:s');
}

}

然后在控制器中使用这些 Accessors：

php
namespace AppHttpControllers;</p>

<p>use AppModelsUser;
use IlluminateHttpRequest;</p>

<p>class UserController extends Controller
{
    public function show($id)
    {
        $user = User::find($id);
        return response()->json([
            'id' => $user->id,
            'name' => $user->name,
            'email' => $user->email,
            'formatted<em>created</em>at' => $user->formatted<em>created</em>at,
            'formatted<em>updated</em>at' => $user->formatted<em>updated</em>at
        ]);
    }
}

使用资源类

Laravel 提供了资源类（Resource）来转换模型数据。我们可以在资源类中定义格式化逻辑。

创建一个资源类：

bash
php artisan make:resource UserResource


然后在资源类中定义格式化逻辑：

php
namespace AppHttpResources;</p>

<p>use IlluminateHttpResourcesJsonJsonResource;</p>

<p>class UserResource extends JsonResource
{
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'formatted<em>created</em>at' => $this->created<em>at->format('Y-m-d H:i:s'),
            'formatted</em>updated<em>at' => $this->updated</em>at->format('Y-m-d H:i:s'),
        ];
    }
}

在控制器中使用资源类：

php
namespace AppHttpControllers;</p>

<p>use AppHttpResourcesUserResource;
use AppModelsUser;
use IlluminateHttpRequest;</p>

<p>class UserController extends Controller
{
    public function show($id)
    {
        $user = User::find($id);
        return new UserResource($user);
    }
}

通过以上几种方法，我们可以在 Laravel 中轻松地格式化时间戳并将其添加到模型的 JSON 响应中。选择哪种方法取决于具体的需求和项目的复杂度。