![JSONの例
{
“id”: 12345,
“name”: “Hiraku NAKANO”,
“tags”: [“PHP”,”JavaScript”]
}](https://image.slidesharecdn.com/jsonschemaandphp-131028085045-phpapp01/85/JSON-Schema-PHP-8-320.jpg)
![JSON Schema
{
integer
“id”: 12345,
“name”: “Hiraku NAKANO”,
“tags”: [“PHP”,”JavaScript”]
}
id, name, tags という
プロパティを持った
オブジェクト
{
string
string[]
“type”:”object”,
“properties”: {
“id”: {“type”:”integer”},
“name”: {“type”:”string”},
“tags”: {
“type”:”array”,
“items”:{“type”:”string”}
}}}](https://image.slidesharecdn.com/jsonschemaandphp-131028085045-phpapp01/85/JSON-Schema-PHP-9-320.jpg)
![もし型が違ったら、判定できる
{
integer
“id”: 12345,
“name”: “Hiraku NAKANO”,
“tags”: “PHP,JavaScript”
}
id, name, tags という
プロパティを持った
オブジェクト
{
string
string[]
“type”:”object”,
“properties”: {
“id”: {“type”:”integer”},
“name”: {“type”:”string”},
“tags”: {
“type”:”array”,
“items”:{“type”:”string”}
}}}](https://image.slidesharecdn.com/jsonschemaandphp-131028085045-phpapp01/85/JSON-Schema-PHP-10-320.jpg)
![超単純な例
JSON
スキーマ
{}
{“type”:”object”}
“abc”
{“type”:”string”}
123
{“type”:”integer”}
[1,2,3]
{“type”:”array”}](https://image.slidesharecdn.com/jsonschemaandphp-131028085045-phpapp01/85/JSON-Schema-PHP-15-320.jpg)
![型固定の配列
JSON
スキーマ
[1,2,3]
{
“type”:”array”,
“items”:{
“type”:”integer”
}
}](https://image.slidesharecdn.com/jsonschemaandphp-131028085045-phpapp01/85/JSON-Schema-PHP-19-320.jpg)
![配列要素数の制約
JSON
スキーマ
[1,2,3]
{
“type”:”array”,
“minItems”:1,
“maxItems”:5
}](https://image.slidesharecdn.com/jsonschemaandphp-131028085045-phpapp01/85/JSON-Schema-PHP-20-320.jpg)
![?a[]=1&a[]=2&a[]=3&b=hogehoge
$_GET === [
‘a’ => [‘1’,’2’,’3’],
‘b’ => ‘hogehoge’
]
JSONだよね！](https://image.slidesharecdn.com/jsonschemaandphp-131028085045-phpapp01/85/JSON-Schema-PHP-39-320.jpg)
![普通に$_GETをバリデーションす
ると結構面倒くさい
<?php
if (
isset($_GET[‘a’], $_GET[‘b’]) &&
is_array($_GET[‘a’]) &&
count($_GET[‘a’]) <= 3 &&
is_string($_GET[‘b’])
) {
//...
}
もっと入れ子になって
いると更に厄介
issetの嵐
これだと何が原因で
駄目だったのか分か
らない](https://image.slidesharecdn.com/jsonschemaandphp-131028085045-phpapp01/85/JSON-Schema-PHP-42-320.jpg)
![<?php
function hoge($a, $b, array $config) {
$args = get_defined_vars();
$args === [
‘a’ => ...,
‘b’ => ...,
‘config’ => ...
];
}](https://image.slidesharecdn.com/jsonschemaandphp-131028085045-phpapp01/85/JSON-Schema-PHP-45-320.jpg)
JSON SchemaとPHP
- 2. 自己紹介 • 中野 拓 • https://twitter.com/Hiraku • http://blog.tojiru.net/ • PHP歴6年ぐらい • 最近使ってるフレームワークはYafとPhalconです • WebAPI関係のお仕事 • 最近コード書いてない。。
- 3. 第一部
- 4. JSON Schema
- 6. JSON Schema • JSONの構造をバリデーションするための仕様 • http://json-schema.org/ • http://json-schema.org/latest/json-schemacore.html
- 8. JSONの例 { “id”: 12345, “name”: “Hiraku NAKANO”, “tags”: [“PHP”,”JavaScript”] }
- 9. JSON Schema { integer “id”: 12345, “name”: “Hiraku NAKANO”, “tags”: [“PHP”,”JavaScript”] } id, name, tags という プロパティを持った オブジェクト { string string[] “type”:”object”, “properties”: { “id”: {“type”:”integer”}, “name”: {“type”:”string”}, “tags”: { “type”:”array”, “items”:{“type”:”string”} }}}
- 10. もし型が違ったら、判定できる { integer “id”: 12345, “name”: “Hiraku NAKANO”, “tags”: “PHP,JavaScript” } id, name, tags という プロパティを持った オブジェクト { string string[] “type”:”object”, “properties”: { “id”: {“type”:”integer”}, “name”: {“type”:”string”}, “tags”: { “type”:”array”, “items”:{“type”:”string”} }}}
- 11. バリデーター実装 バリデーション仕様書 • JSONで記述する • 仕様書を読み取って バリデーションを実行する • 言語ごとに存在 • PHP,JavaScript,Ruby,... JSON Schema
- 12. PHPでの実装 • JSON Schema for PHP がオススメ https://github.com/justinrainbow/json-schema • composerの内部で使われている
- 13. <?php require ‘vendor/autoload.php’; $json = ‘{“a”:1, “b”:2}’; $schema = ‘{ “type”:”object”, “properties”:{ “a”: {“type”:”integer”}, “b”: {“type”:”integer”} } }’; $v = new JsonSchema¥Validator; $v->check(json_decode($json), json_decode($schema)); var_dump($v->getErrors()); エラーがあれば 指摘してくれる
- 18. よく使うパターンはformatで JSON スキーマ “[email protected]” { “type”:”string”, “format”:”email” } date, time, date-time, uri, host-name, email, ipv6, ip-address, color, style,
- 21. 入れ子のオブジェクト JSON { スキーマ { “type”:”object”, “properties”:{ “alice”: ... “bob”: { “type”:”object” } } “alice”: 123, “bob”: { “charlie”: 223 } } } 無限に入れ子可能
- 22. 未定義のプロパティ拒否 JSON { “alice”: 123, “bob”: 223, “charlie”: 323 } スキーマ { “type”:”object”, “properties”: { “alice”: ... “bob”: ... }, “additionalProperties”: false }
- 23. 一通りそろってる感じがする • 詳しくはJSON Schema for PHPのテストを参照！ • 入れ子など、構造のバリデーションが得意なのが JSON Schemaの特徴
- 24. まとめ • JSON Schemaを使うと、JSONをチェックして、期待通 りの構造になっているか調べることができます。 • PHPにもJSON Schemaの実装があります。
- 25. 第一部 完
- 26. ...
- 29. 第二部
- 30. PHPと JSON
- 31. 突然ですが
- 33. ...
- 36. JSONと言えば • boolean, number, stringなどの基本的な型 • array, object を多段に入れ子にした構造
- 38. 例1 $_GET
- 39. ?a[]=1&a[]=2&a[]=3&b=hogehoge $_GET === [ ‘a’ => [‘1’,’2’,’3’], ‘b’ => ‘hogehoge’ ] JSONだよね！
- 40. { } “type”:”object”, “properties”:{ “a”:{ “type”:”array”, “maxItems”:3 }, “b”:{“type”:”string”} }
- 41. <?php //... $v = new JsonSchema¥Validator; $get = json_decode(json_encode($_GET)); $v->check($get, $schema); var_dump($v->getErrors());
- 42. 普通に$_GETをバリデーションす ると結構面倒くさい <?php if ( isset($_GET[‘a’], $_GET[‘b’]) && is_array($_GET[‘a’]) && count($_GET[‘a’]) <= 3 && is_string($_GET[‘b’]) ) { //... } もっと入れ子になって いると更に厄介 issetの嵐 これだと何が原因で 駄目だったのか分か らない
- 43. 例2 関数の引数
- 44. <?php /** * @param int $a * @param string $b * @param array $config */ function hoge($a, $b, array $config) { //... }
- 45. <?php function hoge($a, $b, array $config) { $args = get_defined_vars(); $args === [ ‘a’ => ..., ‘b’ => ..., ‘config’ => ... ]; }
- 47. 以下省略
- 48. つまり
- 51. まとめ • PHP＝だいたいJSON • ゆえに、JSON SchemaはPHPのデータ構 造ならだいたい何でもバリデーションでき る • 手持ちのバリデーションライブラリの1つ として、覚えておくといいと思います
- 52. $ composer require justinrainbow/json-schema (依存パッケージもないので割と使いやすいと思う) 完