DBに入っているデータを決まった書式/形式に変換して表示したり、
逆に逆変換して保存する例は多いかと思います。
変換,逆変換の実装方法は以下みたいな感じかと..。
いずれも変換/逆変換の存在を忘れて仕様が抜けたり、
同じことを他でも書くコードクローンが発生する原因になる。
- Controllerにダラダラと変換/逆変換を書く
- EloquentにオレオレSetter/Getterを書く
Accessor/Mutatorを使うことで上記の原因を無くすことができます。
Accessor/Mutator
Eloquentのメンバ変数（つまり、テーブルのフィールド）へのアクセスを
ある規則をもってEloquentに定義したSetter/Getterを仲介するように強制できます。
Accessors and mutators allow you to format Eloquent attribute values when you retrieve or set them on model instances. For example, you may want to use the Laravel encrypter to encrypt a value while it is stored in the database, and then automatically decrypt the attribute when you access it on an Eloquent model.
In addition to custom accessors and mutators, Eloquent can also automatically cast date fields to Carbon instances or even cast text fields to JSON.
暗号化/復号 サンプル
標題の通りですが、Accessor/Mutatorを使ってフィールドを暗号化/復号してみます。
Cryptファサードを使ってAES-256-CBCの暗号化/復号を行う対です。
secretvalueというフィールドにAES256CBCで暗号化して書き込み、復号して読み込みます。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
class User extends Authenticatable { use Notifiable; /** * Get the user's secretvalue. * * @param string $value * @return string */ public function getSecretvalueAttribute($value) { return decrypt($value); } /** * Set the user's secretvalue. * * @param string $value * @return string */ public function setSecretvalueAttribute($value) { $this->attributes['secretvalue'] = encrypt($value); $this->save(); } } |
透過的に呼び出す例です。
Userのsecretvalueフィールドに”hogehoge”という値を設定しています。
hogehogeという平文を暗号化してsecretvalueフィールドに書き込む処理は使う側には見えません。
|
1 2 3 |
Route::get('/sample/setvalue',function(){ \App\User::find(1)->secretvalue = 'hogehoge'; }); |
Userのsecretvalueフィールドを読み込んで出力しています。
暗号化済み文字列を復号する処理は使う側には見えません。
|
1 2 3 |
Route::get('/sample/getvalue',function(){ echo \App\User::find(1)->secretvalue; }); |
より広い用途で使える
暗号化/復号はかなり直球な使い方ですが、ビジネスロジック内の定型処理など
積極的に使おうとするとAccessor/Mutatorに掃き出せるケースがありそうです。