DOF PHP 项目开发风格/约定/规范。

概念

  • 业务类:指框架之外的由项目开发者自定义的类。

编程

  • 父类不要调用子类方法。

不方便对父类单独进行测试。

  • 业务类之间能不继承就不继承。

  • 不要在项目内定义全局函数。

容易把有状态的类带到函数。DOFS 框架本身也没有提供任何全局函数。

  • 除了业务类是完全无状态和无副作用的,不要在业务类中定义静态方法。

不合理的静态类不方便测试,容易出问题。

  • 不要使用 exit/die:不利于测试、会造成 Swoole 进程异常退出。

命名

  • 所有业务类的业务属性和业务方法名不得使用 _/__ 开头。

  • HTTPPort 内所有以 _ 开头的方法均不被当作 Port 入口方法。

  • 所有以 _ 开头注解名均会被忽略。

  • 所有环境变量一律使用常量风格命名:全部大写,单词之间使用英文下划线 _ 隔开。

不规范的命名会强制被转化为这种风格。

  • 所有配置文件名一律只能使用小写字母。

  • 所有配置 KEY 名尽量不要包括 .. 被用于链式取值时的键名分隔符。

results matching ""

    No results matching ""