PSR规范学习笔记
PSR已经经历了5次变革,如今PSR4就是最新的标准,但是还是有必要了解下5个版本的内容的,于是去php-fig网站看了下英文原版;
大概看了遍,发现这规范很多的必须很多时候只是建议,但是PHP解析器在解析PHP代码时,有时如果不满足规范,就不会通过或者报错。因此写代码时建议尽量以PSR标准来编写,毕竟一个规范的出台,有其重要的现实意义,同时最大的好处是能避免不必要的异常出现;
当然,除此之外,另一个收获是,对框架源码的布局有了更加清晰的了解,所以建议大家有事没事都要把下面几个标准看看,推荐看英文版。(而下面我的笔记只是我比较关注的地方)
如下是PSR五个标准的英文网页:
http://www.php-fig.org/psr/psr-0/
http://www.php-fig.org/psr/psr-1/
http://www.php-fig.org/psr/psr-2/
http://www.php-fig.org/psr/psr-3/
http://www.php-fig.org/psr/psr-4/
PSR-0标准
该标准已经在2014/10/21日被明确宣布废除,取而代之的是PSR-4标准;
大纲如下:
(1) 每一个namespace和class必须是如此命名的:
<vendor name>\(<namespace>\)*<class name>
- 1
(2) 每一个命名空间必须有一个顶级的namespace(vendor name);
(3) 每一个命名空间都必须有一个或多个子命名空间;
(4) 当加载文件时,namespace中的每一个分隔符”\”都会被文件系统的文件分隔符替换;
(5) 当加载文件时,namespace中的每一个下滑线”_”都会被文件系统的文件分隔符替换;
(6) 当加载文件时,在替换后,将在namespace后添加.php来查找文件;
(7) vendor,namespace,class的命名用大小写字母组合而成;
PSR-1标准
(1) php文件必须使用<?php ?>
开头结尾;
(2) php文件必须使用没有BOM的UTF-8编码(可我看我的博客“UTF8的编码规则,文件BOM的由来”);
(3) php编码时应该将无side-effects的代码(如类的声明,函数的声明),和side-effects的代码(改变php环境,改变全局变量,改变数据库),分开文件编写;
(4) 命名空间和类的定义,必须符合自动加载原则,即每个php文件只能定义一个类,而且其namespace必须至少有一个顶级空间名字vendor-name;
(5) 类里面的常量,应该用大写字母和下划线组合定义;
(6) 类里面的属性,命名建议是大小写开头的驼峰型或者小写下划线行,该规则不做强制,但一定的代码范围内建议使用同一种命名方法,便于阅读;
(7) 方法的命名,建议是小写开头的驼峰型;
PSR-2标准
该标准是继承和拓展了PSR-1标准,是编码的基础标准;
(1) 代码的缩进必须是4个space,而不是tabs;
(2) 该标准对代码的行长度没有硬性要求,但是建议一行代码应该小于120个字符或者是少于80个字符;
(3) namespace和use声明下都应该留有一空行;
(4) 类的左花括号必须写在类定义的下一行, 右花括号必须在代码体的下一行;
(5) 方法的花括号规则和类的规则一样;
(6) 所有属性或者方法必须有可见性声明(public,private .etc),而final和abstract必须放在可见性声明前面,而static必须放在可见性声明之后;
(7) 控制结构的关键字(if,switch等)后面必须有个空格,而函数名就不需要了;
(8) 控制结构后面的左花括号必须和控制结构关键字在同一行,右花括号在代码体的下一行;
(9) 控制结构的左花括号后和右花括号前不能有空格;
(10) 所有php文件必须使用unix的换行符进行换行;
(11) 所有php文件结尾必须有一空行;
(12) php代码结束符”?>”,在只有php代码的文件里必须省略;
(13) 非空行,不能在后面添加空格;
(14) php的关键字必须是小写;
(15) extends和implements必须和类的定义写在同一行;
(16) 所有函数的定义前必须加可见性声明;
(17) 函数形参的定义时,每一个参数的前后不能有空格;
PSR-3标准
该标准主要讲述Log体系,暂时放下;
PSR-4标准
该标准主要描述自动加载,兼容PSR-0标准;
(1) 完整类名格式如下:
\<NamsespaceName>(\<SubNamespaceNames>)*\<ClassName>
- 1
要点:
A 必须有一个顶级namespace, 和psr-0时说的Vendor说的是一个东西,这里用“\”符号;
B 必须有一个或多级namespace;
C 以类名结束;
D 下划线不具有独特性(注意和PSR-0区别);
E 可使用人体大小写;
F 整个类名对大小写敏感;
(2) 自动加载继承类不能跑出任何异常(exception,throwable,errors)
PSR规范学习笔记的更多相关文章
- AMD规范学习笔记
背景 NodeJS的一套比较简洁 Moudles 规范, 使得在服务器端的模块化变得更加简单.很长一段时间,很多公司或者项目都有自己的一套模块化机制, 却未能形成一套统一的标准, NodeJS的Mou ...
- 阿里Java编程规范 学习笔记
@import url(http://i.cnblogs.com/Load.ashx?type=style&file=SyntaxHighlighter.css);@import url(/c ...
- CMD规范学习笔记——基于SEAJS实现
CMD(Common Module Definition):该规范明确了模块的书写格式和基本交互规则.通常一个模块就是一个JS文件. 通过define关键字来定义模块,最基本的格式为: define( ...
- usb2.0 规范学习笔记
1.一个USB HOST 最多可以同时支持128 个地址,地址0 作为默认地址,只在设备枚举期间临时使 用,而不能被分配给任何一个设备,因此一个USB HOST 最多可以同时支持127 个地址,如果一 ...
- CSS规范—分类方法(NEC规范学习笔记)
一.CSS文件的分类和引用顺序 Css按照性质和用途,将Css文件分成“公共型样式”.“特殊型样式”.“皮肤型样式”,并以此顺序引用,有需要可以添加版本号 1.公共型样式:包含以下几个部分 标签的重置 ...
- GP card规范学习笔记
9. APDU命令参考 9.1 总的编码规则 A.生命周期状态的编码 可执行的装载文件 b8 b7 b6 b5 b4 b3 b2 b1 含义 16进制命令 0 0 0 0 0 0 0 1 LO ...
- 阿里巴巴JAVA开发规范学习笔记
一.编程规约 (一)命名规约 1.类名驼峰.领域模型除外VO.BO.DTO.DO统称POJO 4.数组String[] args 8.枚举类 Enum ,其实就是特殊的常量类,构造方法强制私有 ( 二 ...
- java虚拟机规范学习笔记之数据类型
1.1 class文件格式 编译后被Java虚拟机所执行的代码使用了一种平台中立的二进制格式来表示,并且经常以文件的形式来存储,这种格式称为class文件格式.class文件格式中精确的定义了类与接口 ...
- XML学习笔记(二)-- DTD格式规范
标签(空格分隔): 学习笔记 XML的一个主要目的是允许应用程序之间自由交换结构化的数据,因此要求XML文档具有一致的结构.业务逻辑和规则.可以定义一种模式来定义XML文档的结构,并借此验证XML文档 ...
随机推荐
- WPF获取相对位置、坐标的方法
1.获取鼠标在控件中的坐标: private void item_MouseDown(object sender, MouseButtonEventArgs e) { Point point = e. ...
- [PY3]——面向对象编程(1)
类的对象 有三种对象 可以做什么操作 包括什么属性 类对象 属性引用.实例化 函数方法.内置的属性.类变量 实例对象 属性引用 函数方法.类变量.实例变量 方法对象 1. 类对象.实例对象.方法对象 ...
- ZOJ 1586 QS Network(Kruskal算法求解MST)
题目: In the planet w-503 of galaxy cgb, there is a kind of intelligent creature named QS. QScommunica ...
- [Codeforces 993E]Nikita and Order Statistics
Description 题库链接 给你一个长度为 \(n\) 的序列 \(A\) ,和一个数 \(x\) ,对于每个 \(i= 0\sim n\) ,求有多少个非空子区间满足恰好有 \(i\) 个数 ...
- MVC部分视图
// 以视图名使用当前文件夹下的视图 // 如果没有找到,则搜索 Shared 文件夹 @Html.Partial("ViewName") @Html.Partial(“视图” ...
- ASP.NET MVC 学习笔记-4.ASP.NET MVC中Ajax的应用
Ajax的全名为:Asynchronous Javascript And XML(异步 JavaScript 和 XML),是指一种创建交互式网页应用的网页开发技术.Ajax技术首先向Web服务器发送 ...
- 数据库连接池使用(一):使用C#数据库连接池
一.导读 使用C#数据库连接池,连接到数据库服务器通常由几个需要软长时间的步骤组成: 1.必须与服务器进行初次连接: 2.必须分析连接字符串信息: 3 ...
- Python 创建字典的多种方式
1.通过关键字dict和关键字参数创建 >>> dic = dict(spam = 1, egg = 2, bar =3) >>> dic {'bar': 3, ' ...
- Linux : task work 机制
task work机制可以在内核中向指定的进程添加一些任务函数,这些任务函数会在进程返回用户态时执行,使用的是该进程的上下文.包括下面的这些API: task_work_add task_work_c ...
- WCF服务使用(IIS+Http)和(Winform宿主+Tcp)两种方式进行发布
1.写在前面 刚接触WCF不久,有很多地方知其然不知其所以然.当我在[创建服务->发布服务->使用服务]这一过程出现过许多问题.如客户端找不到服务引用:客户端只在本机环境中才能访问服务,移 ...