PHPのAPIを作る勉強中ですが

Question

phpでapiを作る勉強中です。

http://localhost/test/apiTest.php?id=1234
http://localhost/test/apiTest.php?flg=1
というURLで、
apiTest.phpにidを渡して、処理する部分はできました。

idから名前を取得する部分と

仮にflgというパラメータが来るとして、
このflgで別のロジックを処理したい場合は、
ファイルを分ける方法しかございませんか？？

今私のレベルでは、ファイル分けて処理するしか思い浮かばずです。

メソッドを分けて呼べる方法とかはありませんか？？

Comments

[HiroshiWatanabe]

(理解できていないのが私だけなら申し訳ないんですけども)
ファイルを分けるという意味がよくわからないんですが
apiTest.php?flg=1ができないからapiTest2.php?flg=1
としなくてはならない、という事…でも無いですよね？
質問の意図がよく理解できません…
「こういう処理を期待してこう記述したけどこんなエラーが出てしまう」
みたいな情報があればしたいことと困ってる内容がわかって答えやすいかも…

[lol]

質問が悪かったです。すみません。

まず、ファイルを分けるという意味は
パラメータが異なる場合の事を伝えるつもりでした。

1.http://localhost/test/apiTest.php?id=1234
パラメータがIDが来る場合

2.http://localhost/test/apiTest.php?flg=1
パラメータがflgが来る場合

この場合に同じファイルでは、別々の処理ができないような気がしました。

また、

3.http://localhost/test/apiTest.php?id=1234&name=suzuki
これもあったとしたら、区別をつけないといけないかなと思って質問しました。

パラメータは5個とか来ると処理できないよなぁと一人で悩んでました。

Answer 1

**「1ファイルに1処理」**というスタイルは，HTML+CSSしか書けなかった素人がWebプログラミングに手をだすための敷居こそ低いものの，機能が増えてくると設計が破綻してきます．「register.php」「postMessage.php」「showMessage.php」「editMessage.php」「showUser.php」「editUser.php」みたいなファイルが大量に並べられることでしょう．

これを防ぐためにPHPを用いた中規模以上の開発ではMVCフレームワークを用いた開発を行うのが一般的です．いきなりこれが敷居が高く感じられるのであれば，V以外を極限まで小さく抑えるマイクロフレームワークを使っても構いません．（後々MVCのほうが良かった，と思うことは多いですが，入門用としてマイクロフレームワークは悪い選択肢ではありません）

• SlimFramework 3

「1ファイルに1処理」問題を解決するためにあるのがルーティングです．これはMVCフレームワークでもマイクロフレームワークでも使われます．ルーティングはURLを見てどういう処理を実行するのかを制御するものです．「*.php」の拡張子を消すことが出来たり，必ずしもパラメータを「?a=b&c=d」の形式で渡す必要がないのもメリットです．例えばこんな感じ．

• 「/entry/list」にGETでアクセスが来たら，投稿一覧を取得する
• 「/entry/post」にPOSTでアクセスが来たら，新規投稿を追加する
• 「/user/profile/ユーザ名」にGETでアクセスが来たら，該当ユーザのプロフィールを取得する

この「〜を取得する」の処理の部分ですが，これを1ファイルにまとめる必要はありません．堂々と分離させましょう．この際，処理をクラスメソッドや関数として定義しておくと，全体の見通しがよくなります．グローバルスコープに処理をズラズラ書き並べるのは可能な限り避けましょう．

• Qiita - Slim 3 Frameworkリリースされたので、ざっと紹介

上記の「コールバックには何が使えるか？」のところでいろいろなパターンが紹介されています．Slimの公式ドキュメントではクロージャを使ったものがほとんどですが，これを乱立させてしまうとまた1ファイルが膨大になってくるのでおすすめできません．**「クラス名:メソッド名」**が一番いいかと思います．

今回はAPIを作りたい，ということでしたよね？おそらくレスポンスをJSONで返すだけだと思うので，ビューに特別な手間をかける必要はないです．以下のように $response オブジェクトから withJSON() メソッドを生やすだけです．

$app->get('/user/profile/{name}', 'UserController:showProfile');

class UserController
{
    public function showProfile($request, $response, $args)
    {
        $params = $request->getQueryParams();
        return $response->withJSON([
            'name' => $args['name'],
            'description' => "{$args['name']}のプロフィール",
            'flag_enabled' => !empty($params['flag']),
        ]);
    }
}

注意: Slim3のwithJsonはステータスコードをデフォルトで200に書き換える

上記のルーティングを行っている場合， http://example.com/user/profile/CertaiN?flag=1 でアクセスすると以下のようなJSONが返ってくるはずです． (見やすくしています)

{
    "name": "CertaiN",
    "description": "CertaiNのプロフィール",
    "flag_enabled": true
}

なお実際にはデータベースに繋いでユーザ情報を取得してくることになると思いますが，全てのメソッドの中にPDOを扱う処理を毎回記述するのは非常に冗長なので，こういう処理は別のクラスにまとめておきましょう．そして，Slim\Appのインスタンスを作る際に渡すコンテナにあらかじめ突っ込んでおき，後から参照するようにしましょう．例えばこんな感じ．

(サービスロケータというアンチパターンを使っているんですが，まぁSlim3がそういう設計思想なのでしょうがないですね)

$container = new Slim\Container;
$container['db'] = function () { return new DB; };

$app = new Slim\App($container);
$app->get('/user/profile/{name}', 'UserController:showProfile');

class UserController
{
    private $db;
    public function __construct(ContainerInterface $container)
    {
        $this->db = $container['db'];
    }
    public function showProfile($request, $response, $args)
    {
        $params = $request->getQueryParams();
        return $response->withJSON([
            'name' => $args['name'],
            'description' => $this->db->getDescriptionByName($args['name']),
        ]);
    }
}

class DB
{
    private $dbh;
    public function __construct()
    {
        $this->dbh = new PDO(...);
    }
    public function getDescriptionByName($name)
    {
        $stmt= $this->dbh->prepare(...);
        ...
        return ...;
    }
}

Comments

[lol]

このような回答がほしかったです。ありがとうございます。

MVCフレームワークを使うとできるとのことですね？
また、DBの接続を毎回するのも悩んでました。

まずは、クラス化をして分離してみます。

ありがとうございます。

Answer 2

なんだかよくわからないけど、

今私のレベルでは、ファイル分けて処理するしか思い浮かばずです。メソッドを分けて呼べる方法とかはありませんか？？

パラメータでメソッドとかを指定すると同じファイルでも分けて処理ができるのかが知りたいことでした。

これですと、idとflgが同時に来るパターンはまた分岐するということでしょうか？？

クラス化まではまだなので、さっぱりですが

という良い子のみんなの意見を纏めると、

apiTest.php

if(isset($_GET["id")){
    doIdMethod($_GET["id"]);
}

if(isset($_GET["flg"])){
    doFlgMethod($_GET["flg"]);
}

function doIdMethod($id){
    // $idでの処理
}

function doFlgMethod($flg){
    // $flgでの処理
}

こんなんでましたけど？

Comments

[lol]

これは違います。

Answer 3

クラス化してみたら幸せになれるかも?

Comments

[lol]

クラス化まではまだなので、さっぱりですが

http://www.objective-php.net/mvc/dispatcher
ここを見る限りでは、クラス化しないといけないようですね。

[lol]

ちなみに、

$dsn = 'mysql:dbname=test;host=localhost';
$user = 'testuser';
$password = 'testuser';
$id = $_GET['id'];
try{
$dbh = new PDO($dsn, $user, $password);
$dbh->query('SET NAMES sjis');

$sql = 'select id, name from name_table where id == ?';
$stmt = $dbh->prepare($sql);
$stmt->execute(array($id));

while($result = $stmt->fetch(PDO::FETCH_ASSOC)){
print($result['id']);
print($result['name'].'<br>');
}

}catch (PDOException $e){
print('Error:'.$e->getMessage());
die();
}

これをクラス化するのは簡単にできるものでしょうか？？

[HiroshiWatanabe]

＞ここを見る限りでは、クラス化しないといけないようですね。

クラスにしなくても要求を満たす事はできると思います。
答えに至る道（実現手段）は１つではありませんので。

＞これをクラス化するのは簡単にできるものでしょうか？？

はい。クラスにする事自体はそんなにムズカシイ事ではありません。

Answer 4

ん？

if (@$_GET['flg'] == 1) {
  // 1の処理
}
elseif ($_GET['flg'] == 2) {
  // 2の処理
}
else {
  // その他
}

みたいな？

###追記
パラメータに値を付けると、HTTPプロトコルではGETでデータを受け取ることになります。
フォームなどにデータを入力してデータを受け取る場合、POSTでデータを受け取ります。

しかし、実はリクエストヘッダーの中身を見ると興味深いです。

flg=1&id=1234&name=suzuki
```のように渡しています。
そして、PHPはそのデータを直接利用することができます。
```PHP
$id = $_POST['id'];
```とするだけで、idを変数に入れて利用可能です。

これはURLパラメータでも同じです。

Comments

[lol]

これですと、idとflgが同時に来るパターンはまた分岐するということでしょうか？？

[shi_ue]

まあ、分岐したければそうすればいいですし、その値を使って他の処理をするなら、そうすればいいです。
ソースをご提示いただけていないので、何とも答えようがありません。

[lol]

$dsn = 'mysql:dbname=test;host=localhost';
$user = 'testuser';
$password = 'testuser';
$id = $_GET['id'];
try{
$dbh = new PDO($dsn, $user, $password);
$dbh->query('SET NAMES sjis');

$sql = 'select id, name from name_table where id == ?';
$stmt = $dbh->prepare($sql);
$stmt->execute(array($id));

while($result = $stmt->fetch(PDO::FETCH_ASSOC)){
print($result['id']);
print($result['name'].'<br>');
}

}catch (PDOException $e){
print('Error:'.$e->getMessage());
die();
}

コードならこれですけど、想定の話でしたので。。
関連のない処理の場合に同じファイルで全部書くのができるのかの質問です。

SQLとか、最終的にはjsonに変換するので、別ファイルわけだと同じ処理を何回もしないといけないような気がして。

[shi_ue]

APIだから、関連がない動作を一つのファイルでやるのはどうか、という質問なんですか？
ちょっと質問の意図が読み取れません。ソースを見てもidしかないし・・・

[lol]

http://www.objective-php.net/mvc/dispatcher

ここに記載されている、
コントローラーの振り分けみたいのができるのかと思ってました。

$controller = 'index';
if (0 < count($params)) {
$controller = $params[0];
}

// パラメータより取得したコントローラー名によりクラス振分け
$controllerInstance = null;
switch ($controller) {
case 'index':
$controllerInstance = new IndexController();
break;
case 'product':
$controllerInstance = new ProductController();
break;
case 'cart':
$controllerInstance = new CartController();
break;
default:
header("HTTP/1.0 404 Not Found");
exit;
break;
}

パラメータでメソッドとかを指定すると同じファイルでも分けて処理ができるのかが知りたいことでした。

[mpyw]

「リクエストを受け取った段階で問答無用でサニタイズする」というのは誤った設計です．「エスケープすべき瞬間にその用途に応じたエスケープを行う」のが正しいです．詳しくは「サニタイズ言うなキャンペーン」でググってください．このキャンペーン啓発者曰く「サニタイズは死語として扱うべきだ」だそうですが，そのとおりだと思います．

[mpyw]

>> $dbh->query('SET NAMES sjis');

これは絶対にやめてください．この書き方をするとプレースホルダを使っていてもSQLインジェクションを受ける可能性があります．詳しくは以下の徳丸さんのブログを参照してください．

http://www.tokumaru.org/d/20100701.html

設計方針としては，まずそもそもShift_JISなんて古臭い文字コードを使わないこと．今のWebでは全ての文字コードをUTF-8に統一するのがもはや当たり前です．Shift_JISをPHPで使うとデメリットが沢山あります．例えば str_replace や explode といった関数はよく使うと思いますが，Shift_JISエンコードされた文字列に対しては動作保証されていません．また，文字コードの設定にはDSNのcharset指定を使うようにしてください．

$dsn = 'mysql:dbname=test;host=localhost;charset=utf8';

>> $sql = 'select id, name from name_table where id == ?';

これ構文エラーになると思います．SQLの比較は「==」じゃなくて「=」です．

また，SQLの構文エラーなどにもすぐ気づけるように，「new PDO」以外の部分でもPDOExceptionがスローされるように必ず以下の設定を最初に行ってください．これを行わないと全体をtry~catchで括る意味がありません．

$dbh->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

[shi_ue]

Re: CertaiNさん
老婆心で余計な一言を入れてしまいました。言われてみればそうですよね。
わたしもサニタイズなんてしてませんし（笑）
初心者のように見えるからって、いい加減なことを書かないように気を付けます。