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将TextBox的边框设为圆角的
将TextBox的边框设为圆角的,因为TextBox默认的样式中边框就是由Border类型来实现的, 所以只需要真的当前的TextBox的Border修改属性即可,为了不影响界面中别的Border的样 ...
- Node.js最新Web技术栈(2016年4月)
Node.js是比较简单的,只有你有前端js基础,那就按照我的办法来吧!一周足矣,虽然这版上了es语法,但依然是可以简单写,也可以难写,参见<全栈工程师之路-Node.js>,里面讲了No ...
- Java I/O流-总结(InputStream,OutputStream,Reader,Writer)
Java流总结 一. 流的分类 • 按数据流动方向 – 输入流:只能从中读取字节数据,而不能向其写出数据 – 输出流:只能向其写入字节数据,而不能从中读取数据 • 按照流所处理的数据类型 – 字节流: ...
- 匿名函数、闭包、lambda表达式、Block
C#有lambda.匿名函数,js有匿名函数.闭包,OC中有block,看到这是不是心中有一万个草泥马在跑,不过它们这些都是换汤不换药,不同语言名字不一样. 从功能性上说lambda和closure( ...
- C# 获取config文件 实体转换
随着项目的扩展,单独的key,value配置文件已经不能满足需求了 这里需要自定义配置节点,例如 <!--自定义 具体实体类配置问节点信息--> <School Name=" ...
- Javascript数组操作函数总结
(1) shift 删除原数组第一项,并返回删除元素的值:如果数组为空则返回undefined var a = [1,2,3,4,5]; var b = a.shift(); //a:[2,3,4, ...
- SpringMVC中数据转换
SpringMVC中接收到的数据都是String形式,然后再根据反射机制将String转换成对应的类型.如果此时想接收一个Date类型,那么我们可以定义一个转换器来完成. 例如,我们有下面的Emp类: ...
- Java基础教程(22)--异常
一.什么是异常 异常就是发生在程序的执行期间,破坏程序指令的正常流程的事件.当方法中出现错误时,该方法会创建一个对象并将其交给运行时系统.该对象称为异常对象,它包含有关错误的信息,包括错误的类型和 ...
- 使用IDEA工具配置和运行vue项目(详细其中的坑)
刚来公司实习发现公司的前端使用的是vue,之前根本就没有听说过.然后一上来就需要看代码,but but 就是没有文档什么的东西, 就需要自己去研读,我就想去运行其中的前端和后端联调起来方便理解,结果在 ...
- 动态We API层(动态生成js)
ABP动态webapi前端怎么调用? 研究abp项目时,页面js文件中一直不明白abp.services... 是从哪里来的 在调试SimpleTaskSystem的AngularJs demo时,一 ...