0

0

FIG-PHP PSR规范系列1-基础编码规范

php中文网

php中文网

发布时间:2016-06-23 13:29:42

|

1517人浏览过

|

来源于php中文网

原创

1. FIG-PHP与PSR简介

    fig-php制定了一系列php开发规范,简称psr,这里fig是框架互操作工作组(framework interoperability group)的简称,psr是php标准推荐(php standard recommendation)的缩写。fig-php工作组最初是源于项目代表讨论两个项目之间的共性时,找出可以共事的方式。主要的受众是双方项目组,但php界的其他人也在观望。如果其他人愿意采用这里的规范,那么欢迎,但这并非工作组的目标。工作组中没人会告诉你如何来建造应用。

    截止到2015.07, PSR共有五个规范文档发布,分别是:

PSR-0 自动加载(2014.10.21被废弃,替代规范为PSR-4)

PSR-1 基础编码规范

PSR-2 编码风格

立即学习PHP免费学习笔记(深入)”;

PSR-3 日志接口

PSR-4 改进的自动加载

PSR-7 HTTP消息接口


   下面将分多个系列来学习这些规范, 本文档是系列1。

2. PSR-1: 基础编码规范

   本规范讨论一些基础的代码规范,以便将来代码共享时不同代码之间能有更高程度的技术互操作。

   本规范中的必须(MUST),不可(MUST NOT),应当(SHOULD),不应当(SHOULD NOT),可以/可能(MAY)等关键词的含义可参见RFC 2119。

2.1 概述

源文件必须(MUST)只使用

源文件中php代码的编码格式必须(MUST)只使用不带字节顺序标记(BOM)的UTF-8。备注:更多BOM资料可参见参考资料[BOM]。

一个源文件建议只用来做声明(类(class),函数(function),常量(constant)等)或者只用来做一些辅助作用的操作(例如:输出信息,修改.ini配置等),但不应当(SHOULD NOT)同时做这两件事。

命名空间(namespace)和类(class) 必须遵循一种PSR自动加载规范: PSR-0或PSR-4。(译者注:由于PSR-0已经被废弃,因此这里事实上等同于必须遵循PSR-4规范。)

类名(class name) 必须使用StudlyCaps写法。

(译者注:参见参考资料[StudlyCaps], StudlyCaps是一种大小写字母可任意变化,其中一些字母可被忽略的一种写法。例如消息可能隐藏在大写字母与小写字母中,例如"ShoEboX"大写字母可拼出"SEX", 小写祖母可拼出"hobo", webmail服务商Hotmail最初被写为HoTMaiL, 大写字母可拼出HTML。)

类(class)中的常量必须只由大写字母和下划线(_)组成。

方法名(method name) 必须使用camelCase(驼峰式)写法。

2.2 文件

2.2.1 PHP标签

    PHP代码必须只使用长标签()或者短输出式标签(=  ?>);而不可使用其他标签。

2.2.2 字符编码

   PHP代码的编码格式必须只使用不带字节顺序标记(BOM)的UTF-8。

2.2.3 辅助作用

    一个源文件建议只用来做声明(类(class),函数(function),常量(constant)等)或者只用来做一些辅助作用的操作(例如:输出信息,修改.ini配置等),但不建议同时做这两件事。

    短语 辅助作用(side effects)的意思是与声明(类(class),函数(function),常量(constant)等)没有直接关系的一些执行逻辑。

    (译者注:[PSR-1-翻译1]中将side effects翻译为副作用,[PSR-1-翻译2]中翻译为从属效应 , 都感觉不知所云,这里翻译为辅助作用应当更好)。

易企CMS1.8
易企CMS1.8

易企CMS:国内首款完全基于SEO友好性开发的营销型企业网站系统,让企业网络营销从此易如反掌。 本程序特征:100%开发源代码,免费开源;后台管理操作简单易行;模板div+css标准设计,符合w3c标准,兼容主流浏览器;开发语言和数据库:PHP+Mysql。 本程序亮点:从基础代码开发起完全符合SEOWHY理论的SEO规范,力图实现国内首款对SEO最友好的企业网站开源程序,为企业网络营销的巨大成功

下载

    (译者注:原文中的merely from including the file没有弄清楚是什么意思,留待以后确认)。

  辅助作用包含但不局限于:产生输出,显式地使用require或include,连接外部服务,修改ini配置,触发错误或异常,修改全局或者静态变量,读取或修改文件等等。

    下面是一个既包含声明又有辅助作用的示例文件;即应避免的例子:

<?php// 副作用:修改了ini配置ini_set('error_reporting', E_ALL);// 副作用:载入了文件include "file.php";// 副作用:产生了输出echo "<html>\n";// 声明function foo(){    // 函数体}


下面是一个仅包含声明的示例文件;即应提倡的例子:

<?php// 声明function foo(){    // 函数体}// 条件式声明不算做是辅助作用if (! function_exists('bar')) {    function bar()    {        // 函数体    }}

2.3 空间名(namespace)和类名(class name)

    命名空间(namespace)和类(class)必须遵循一种自动加载规范PSR-0或PSR-4.

    这意味着一个源文件中只能有一个类(class),并且在命名空间中至少要有一级:即一个顶级的组织名(vendor name)。

   类名(class name) 必须使用StudlyCaps写法。

   PHP5.3之后的代码必须使用正式的命名空间(namespace) 

例子:

<?php// PHP 5.3 及之后:namespace Vendor\Model;class Foo{}


PHP5.2.x之前的代码建议用伪命名空间Vendor_作为类名(class name)的前缀

<?php// PHP 5.2.x 及之前:class Vendor_Model_Foo{}


2.4 类的常量、属性和方法

    术语类(class)指所有的类(class),接口(interface)和trait。

2.4.1 常量

    类常量必须(MUST)只由大写字母和下划线(_)组成。 例子:

<?phpnamespace Vendor\Model;class Foo{    const VERSION = '1.0';    const DATE_APPROVED = '2012-06-01';}

2.4.2 属性

    类的属性命名可以遵循$StulyCaps,$camelCase或者$under_score中的某一种风格,本规范不做强制要求,但无论遵循哪种命名方式,都应当(SHOULD)在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。

2.4.3 方法

    方法名必须(MUST)使用camelCase风格来声明。

3. 参考资料

[BOM] 一个bom头引发的血案, 

[PHP-FIG] php-fig, http://www.php-fig.org/

[PSR-1-翻译1] PSR-1基本代码规范, https://github.com/hfcorriez/fig-standards/blob/zh_CN/%E6%8E%A5%E5%8F%97/PSR-1-basic-coding-standard.md

[PSR-1-翻译2] PHP PSR-1 基本代码规范(中文版), http://segmentfault.com/a/1190000002521577

[PSR-4] FIG-PHP PSR规范系列4-自动加载,

[RFC2119] Key words for use in RFCs to Indicate Requirement Levels, March 1997, http://www.ietf.org/rfc/rfc2119.txt

[RFC2119-阮一峰] RFC2119:表示要求的动词, http://www.ruanyifeng.com/blog/2007/03/rfc2119.html

[StudlyCaps] Studly caps, https://en.wikipedia.org/wiki/Studly_caps

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

463

2026.02.13

微博网页版主页入口与登录指南_官方网页端快速访问方法
微博网页版主页入口与登录指南_官方网页端快速访问方法

本专题系统整理微博网页版官方入口及网页端登录方式,涵盖首页直达地址、账号登录流程与常见访问问题说明,帮助用户快速找到微博官网主页,实现便捷、安全的网页端登录与内容浏览体验。

135

2026.02.13

Flutter跨平台开发与状态管理实战
Flutter跨平台开发与状态管理实战

本专题围绕Flutter框架展开,系统讲解跨平台UI构建原理与状态管理方案。内容涵盖Widget生命周期、路由管理、Provider与Bloc状态管理模式、网络请求封装及性能优化技巧。通过实战项目演示,帮助开发者构建流畅、可维护的跨平台移动应用。

64

2026.02.13

TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

20

2026.02.13

Redis高可用架构与分布式缓存实战
Redis高可用架构与分布式缓存实战

本专题围绕 Redis 在高并发系统中的应用展开,系统讲解主从复制、哨兵机制、Cluster 集群模式及数据分片原理。内容涵盖缓存穿透与雪崩解决方案、分布式锁实现、热点数据优化及持久化策略。通过真实业务场景演示,帮助开发者构建高可用、可扩展的分布式缓存系统。

26

2026.02.13

c语言 数据类型
c语言 数据类型

本专题整合了c语言数据类型相关内容,阅读专题下面的文章了解更多详细内容。

29

2026.02.12

雨课堂网页版登录入口与使用指南_官方在线教学平台访问方法
雨课堂网页版登录入口与使用指南_官方在线教学平台访问方法

本专题系统整理雨课堂网页版官方入口及在线登录方式,涵盖账号登录流程、官方直连入口及平台访问方法说明,帮助师生用户快速进入雨课堂在线教学平台,实现便捷、高效的课程学习与教学管理体验。

14

2026.02.12

豆包AI网页版入口与智能创作指南_官方在线写作与图片生成使用方法
豆包AI网页版入口与智能创作指南_官方在线写作与图片生成使用方法

本专题汇总豆包AI官方网页版入口及在线使用方式,涵盖智能写作工具、图片生成体验入口和官网登录方法,帮助用户快速直达豆包AI平台,高效完成文本创作与AI生图任务,实现便捷智能创作体验。

524

2026.02.12

PostgreSQL性能优化与索引调优实战
PostgreSQL性能优化与索引调优实战

本专题面向后端开发与数据库工程师,深入讲解 PostgreSQL 查询优化原理与索引机制。内容包括执行计划分析、常见索引类型对比、慢查询优化策略、事务隔离级别以及高并发场景下的性能调优技巧。通过实战案例解析,帮助开发者提升数据库响应速度与系统稳定性。

53

2026.02.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
【李炎恢】ThinkPHP8.x 后端框架课程
【李炎恢】ThinkPHP8.x 后端框架课程

共50课时 | 4.6万人学习

第三期培训_PHP开发
第三期培训_PHP开发

共116课时 | 26.7万人学习

PHP零基础通关宝典
PHP零基础通关宝典

共78课时 | 9.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号