직렬화
ㅋㅋ 및 컬렉션
- JSON 속성 숨기기
- JSON 값 추가
- IntroductionBuild J SON API를 사용할 때 모델과 연관을 배열이나 JSON으로 변환해야 하는 경우가 많습니다. 이러한 작업을 위해 Eloquent는 직렬화에서 몇 가지 편리한 방법과 속성 제어를 제공합니다.
- 직렬화된 모델 및 컬렉션
Serialize to array
모델과 로드된 연결을 배열로 변환하려면 toArray
메서드를 사용할 수 있습니다. 이는 재귀적 방법이므로 모든 속성과 관계(관련 관계 포함)가 배열로 변환됩니다. toArray
方法。这是一个递归的方法,因此所有的属性和关联(包括关联的关联)都将转化成数组:
$user = App\User::with('roles')->first();return $user->toArray();
也可以转化整个模型 集合 为数组:
$users = App\User::all();return $users->toArray();
序列化为 JSON
方法 toJson
可以把模型转化成 JSON。和方法 toArray
一样, toJson
方法也是递归的,因此所有属性和关联都会转化成 JSON, 你还可以指定由 PHP 支持的 JSON 编码选项:
$user = App\User::find(1); return $user->toJson(); return $user->toJson(JSON_PRETTY_PRINT);
也可以把模型或集合转成字符串,方法 toJson
将自动调用:
$user = App\User::find(1); return (string) $user;
由于模型和集合在转化为字符串的时候会转成 JSON, 因此可以在应用的路由或控制器中直接返回 Eloquent 对象:
Route::get('users', function () { return App\User::all(); });
隐藏 JSON 属性
有时要将模型数组或 JSON 中的某些属性进行隐藏,比如密码,则可以在模型中添加 $hidden
属性:
<?php namespace App; use Illuminate\Database\Eloquent\Model; class User extends Model{ /** * 数组中的属性会被隐藏。 * * @var array */ protected $hidden = ['password']; }
{note} 隐藏关联时,需使用关联的方法名。
此外,也可以使用属性 $visible
定义一个模型数组和 JSON 可见的白名单。转化后的数组或 JSON 不会出现其他的属性:
<?phpnamespace App; use Illuminate\Database\Eloquent\Model; class User extends Model{ /** * 数组中的属性会被展示。 * * @var array */ protected $visible = ['first_name', 'last_name']; }
临时修改可见属性
如果需要在一个模型实例中显示隐藏的属性,就可以使用 makeVisible
方法。方法 makeVisible
返回模型实例:
return $user->makeVisible('attribute')->toArray();
相应地,需要在一个模型实例中隐藏可见的属性,则可以使用 makeHidden
方法。
return $user->makeHidden('attribute')->toArray();
追加 JSON 值
有时,需要在数组或 JSON 中添加一些数据库没有字段对应的属性。 要实现这个功能,先为其定义一个访问器:
<?php namespace App; use Illuminate\Database\Eloquent\Model; class User extends Model{ /** * 为用户获取管理员标识。 * * @return bool */ public function getIsAdminAttribute() { return $this->attributes['admin'] == 'yes'; } }
然后,在模型属性 appends
中添加该属性名。注意,尽管访问器使用「驼峰命名法」方式定义,但是属性名通常以「蛇形命名法」方式引用。
<?php namespace App; use Illuminate\Database\Eloquent\Model; class User extends Model{ /** * 追加到模型数组表单的访问器。 * * @var array */ protected $appends = ['is_admin']; }
使用 append
方法追加属性后,它将包含在模型的数组和 JSON 中。 appends
数组中的属性也将遵循模型上配置的 visible
和 hidden
设置。
运行时追加
在单个模型实例上,使用方法 append
追加属性,或者,使用方法 setAppends
return $user->append('is_admin')->toArray(); return $user->setAppends(['is_admin'])->toArray();전체 모델 컬렉션을 배열로 변환할 수도 있습니다.
protected $casts = [ 'birthday' => 'date:Y-m-d', 'joined_at' => 'datetime:Y-m-d H:00', ];
toJson
메서드를 사용하면 모델을 JSON으로 변환할 수 있습니다. toArray
메서드와 마찬가지로 toJson
메서드는 재귀적이므로 모든 속성과 관계가 JSON으로 변환됩니다. PHP 인코딩 옵션 🎜: 🎜<?php namespace App\Providers; use Illuminate\Support\Carbon; use Illuminate\Support\ServiceProvider; class AppServiceProvider extends ServiceProvider{ /** * 执行注册后,启动服务 * * @return void */ public function boot() { Carbon::serializeUsing(function ($carbon) { return $carbon->format('U'); }); } /** * 在服务容器中注册绑定 * * @return void */ public function register() { // } }🎜 모델이나 컬렉션을 문자열로 변환할 수도 있습니다.
toJson
메서드는 다음과 같습니다. 자동 호출 :🎜rrreee🎜모델과 컬렉션은 문자열로 변환될 때 JSON으로 변환되므로 Eloquent 객체는 애플리케이션의 경로나 컨트롤러에서 직접 반환될 수 있습니다: 🎜rrreee🎜🎜 🎜JSON 속성 숨기기
🎜때때로 모델 배열이나 JSON에서 비밀번호와 같은 일부 속성을 숨기고 싶은 경우 추가할 수 있습니다. 모델에 대한$hidden
속성: 🎜rrreee🎜{note} 연관을 숨길 때 연관된 메소드 이름을 사용해야 합니다. 🎜🎜또한
$visible
속성을 사용하여 JSON에 표시되는 모델 배열과 화이트리스트를 정의할 수도 있습니다. 변환된 배열 또는 JSON에는 다른 속성이 표시되지 않습니다. 🎜rrreee표시되는 속성을 일시적으로 수정
🎜모델 인스턴스에 필요한 경우 표시하려면 숨겨진 속성인 경우makeVisible
메서드를 사용할 수 있습니다. makeVisible
메소드는 모델 인스턴스를 반환합니다: 🎜rrreee🎜따라서 모델 인스턴스에서 표시되는 속성을 숨겨야 하는 경우 makeHidden
메소드를 사용할 수 있습니다. 🎜rrreee🎜🎜🎜JSON 값 추가
🎜때때로 다음이 필요합니다. 데이터베이스에 해당 필드가 없는 배열 또는 JSON에 일부 속성을 추가합니다. 이 기능을 구현하려면 먼저 해당 접근자를 정의하세요: 🎜rrreee🎜 그런 다음 모델 속성appends
에 속성 이름을 추가하세요. 접근자는 camelCase를 사용하여 정의되지만 속성 이름은 일반적으로 SnakeCase를 사용하여 참조됩니다. 🎜rrreee🎜append
메소드를 사용하여 속성을 추가하면 모델의 배열과 JSON에 속성이 포함됩니다. appends
배열의 속성은 모델에 구성된 visible
및 hidden
설정도 존중합니다. 🎜런타임 추가
🎜단일 모델 인스턴스에서append
메소드를 사용하여 속성을 추가하거나, setAppends
메소드를 사용하면 추가된 속성의 전체 배열을 다시 작성합니다: 🎜rrreee🎜🎜🎜🎜🎜🎜직렬화된 날짜
모든 속성의 날짜 형식을 사용자 정의하세요
Eloquent의 속성 유형 변환에서 날짜 속성의 날짜 형식을 개별적으로 사용자 정의할 수 있습니다:
rrreeeCarbon 전역 사용자 정의
Laravel은 Carbon 날짜 라이브러리를 확장합니다. 이는 Carbon의 JSON 직렬화에 편의성을 제공합니다. 애플리케이션 전체에서 모든 Carbon 날짜의 직렬화를 사용자 정의하려면 날짜를 문자열로 반환하는 클로저를 허용하는 Carbon::serializeUsing
方法。方法 serializeUsing
를 사용할 수 있습니다.