ホームページ > 記事 > バックエンド開発 > PHP開発仕様例を詳しく解説

PHP開発仕様例を詳しく解説

小云云オリジナル: 2018-02-06 16:17:372594ブラウズ

この記事では主に PHP 開発仕様の詳細な例を紹介し、皆様のお役に立てれば幸いです。

ソースファイル

コードは01844e580db6b89875af111f2920edf0で始まります

ファイル形式はBOMフリーのUTF-8形式である必要があります

ファイルは次のような1つのタイプのみを宣言しますクラスとインターフェイスをソースファイル内で混在させることはできません

インデント

インデントには 4 つのスペースを使用し、IDE で設定可能です

行の長さ

1 行あたり 120 文字

キーワード

すべてのキーワード

すべて小文字、 true、falseなど

Name

クラス名はUserModelなどのキャメルケースです

クラスメソッドの名前はgetUserId()などの小さなキャメルケースで付けられます

関数は小文字と_を使用します。たとえば、 get_cookie()

変数名は$userIdなどのキャメルケースを使用します

定数はIS_DEBUGなどの大文字と_の組み合わせとして定義されます

コードコメントタグ

クラス、メソッド、クラス内の属性ファイルコメント、@param @return @throwns

@param コメントを使用して、@param string $username ユーザー名

ビジネスモジュール

などの詳細な説明を記述します。ルートは、小文字と _ で構成されます。 /api/get_user_info

ビュー層はデータ表示を担当します

コントローラー層は入力パラメータの検証を担当し、最も外側の層は例外をキャプチャし、ロジック層とビュービュー層を呼び出します

ロジック層は特定のビジネスロジックを担当し、モデル層を呼び出し、処理データを返します

Model 層はデータテーブルのクエリと関連付けを担当します。たとえば、ParamException はパラメータエラーを意味し、UserException はカスタム例外を意味します。コードを分類して定義し、代わりに

<?php
namespace app\exceptions\codes;

class UserExceptionCode extends BaseExceptionCode {
  const NO_AUTH       = 1000001;
  const NO_AUTH_MSG     = &#39;不具有权限&#39;;
  const STATUS_EXCEPTION   = 1000002;
  const STATUS_EXCEPTION_MSG = &#39;状态异常&#39;;    
}

などの PHP クラス定数を使用します。データテーブルファイルに Enum 型がある場合は、代わりに

<?php
namespace app\enums;

class UserEnum extends BaseEnum {
  const STATUS_DELETED = -1;// 已删除
  const STATUS_DISABLE = 0;// 禁用
  const STATUS_ENABLE = 1;// 正常

  const AUTH_GUEST     = 1;// 匿名用户
  const AUTH_GENERAL_ADMIN = 2;// 普通管理员
  const AUTH_SUPER_ADMIN  = 3;// 超级管理员
}

などの PHP クラス定数を使用します。STATUS と AUTHデータテーブルマッピングのフィールド名です

API インターフェイスの出力です。例:

{
  "code" : 0,
  "msg" : "success",
  "data" : {
    "userId" : 100
  }
}

code と msg は必須フィールドです。データが空の場合は入力しないでください。例:

{
  "code" : 100001,
  "msg" : "不具有权限"
}

Others

array 、キーが文字列の場合は一重引用符を使用します。キーが 1 つだけの場合は 1 行を使用します。例:

$arr = [ &#39;userId&#39; => 100 ];

more キーごとに複数の行を使用します。例:

$arr = [
  &#39;id&#39;    => 100,
  &#39;username&#39; => &#39;admin&#39;,
];

文字列には一重引用符を使用します。