집 > 기사 > 백엔드 개발 > PHP 개발 사양 예시에 대한 자세한 설명

PHP 개발 사양 예시에 대한 자세한 설명

小云云원래의: 2018-02-06 16:17:372593검색

이 기사는 모든 사람에게 도움이 되기를 바라며 PHP 개발 사양의 자세한 예를 주로 공유합니다.

소스 파일

코드는 00514c5f1e46eccc0d2838c283b2e0f8

파일 형식은 BOM-free UTF-8 형식이어야 합니다.

파일은 다음과 같은 한 가지 유형만 선언합니다. 클래스와 인터페이스는 소스 파일에서 혼합할 수 없습니다.

Indentation

4개의 공백을 들여쓰기에 사용할 수 있습니다. IDE는

줄 길이

한 줄당 120자

Keywords

모든 키워드는 모두 소문자입니다. true, false

Name

클래스 이름은 UserModel

과 같이 CamelCase로 되어 있습니다. 클래스 메소드는 getUserId()

와 같이 작은 CamelCase로 이름이 지정됩니다. 함수는 소문자에 _를 사용합니다. 예를 들어, get_cookie()

$userId와 같은 변수 이름에 카멜 표기법을 사용합니다

상수는 IS_DEBUG

코드 주석 태그

클래스, 메소드 및 속성과 같이 대문자와 _의 조합으로 정의됩니다. 클래스 파일에서 Comment, @param @return @throwns

@param comment를 사용하여 @param string $username Username

Business module

경로는 소문자 + _로 구성됩니다. 예: /api/get_user_info

View 레이어는 데이터 표시를 담당합니다

Controller 레이어는 입력 매개변수 확인을 담당하고, 가장 바깥쪽 레이어는 예외를 캡처하고 Logic 및 View 뷰 레이어를 호출합니다.

Logic 레이어는 특정 비즈니스를 담당합니다. 로직, 모델 레이어 호출, 데이터 처리 반환

모델 레이어는 데이터 테이블 쿼리 및 연결을 담당합니다.

예외 클래스는 함수를 구별해야 합니다. 예를 들어 ParamException은 사용자 정의 예외를 의미합니다. 예외는 코드로 분류 및 정의되어야 하며 대신

<?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 클래스 상수를 사용하세요. 및 AUTH는 데이터 테이블 매핑 필드 이름입니다

Api 인터페이스 출력입니다. 예:

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

여기서 code 및 msg는 필수 필드입니다. 데이터가 비어 있으면 입력하지 마세요. 예:

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

Others

배열, 키가 문자열인 경우 작은따옴표 사용, 키가 하나만 있는 경우 한 줄 사용, 예

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

more 각 키에 여러 줄 사용, 예

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

작은따옴표 사용 strings '