最近在带组内的新人基于 hyperf 项目进行开发, 目标是构建一整套 PHP 微服务的体系. 千里之行始于足下, 这里先 mark 一下一些基础的编程注意事项
hyperf 编程注意事项
禁止项
$path = $_SERVER['HTTP_REFERER'];不可以使用超全局变量, swoole server 是常驻进程 epoll 方式处理请求, 不是 fpm 依靠多进程一对一处理请求
配置管理 config
- 所有配置都在 config 文件中, 项目中只使用 config() 就可以获取配置
- .env 只写环境相关配置, 最后都需要使用 env() 配置到 config 文件中, env() 只允许在 config 文件中使用
修改 PHP 配置
container.php保持和官方同步,int_set() define()等可以配置到 hyperf.php 文件中
容器 container
- 尽量使用框架提供的功能, 这样才能发挥出 container 的效果
- 手动 new 的对象, 没有交给 container 管理, 无法使用框架提供的注解功能, 比如
@Inject
协程 go/coroutine
- 使用协程有2个必须条件: 开协程
go() + callback 中执行非阻塞代码 - 常用的库都提供了非阻塞调用: mysql(基于laravel ORM + 连接池), redis(ext-redis + 连接池), http(guzzle clientFactory)
http client
- http 请求这样的功能很常见, 几乎所有的项目都会自己的封装, 但是要使用 hyperf 提供的
hyperf/guzzle, 才能实现非阻塞调用 - 项目自己封装的 http 请求库, 基本可以断定没有
guzzle/http好用
基于 hyperf 的封装
基于 hyperf 的封装 务必 要考虑 反哺 社区, 有以下几点:
- hyperf 的迭代速度, 包括功能支持上, 速度有目共睹, 所谓的封装, 也许就在下次发版支持了
- hyperf 的代码提交以及整个社区共建, 保证了代码风格和相当高的
代码质量 反哺社区也是依赖解决的最优解之一- 最后再来一句灵魂拷问:
自己再封装一层真的有必要么?
建议项:
- 大段注释的代码基本建议删掉, 哪怕真的有需要, 也可以从 git log 里找回, 我认为这是
clean code的要求之一 - 不建议使用常量, hyperf 只设置了一个常量
BASE_PATH, 使用常量通常是没想好要怎么放, 建议多看看 hyperf 的组件设计
Unix哲学（Unix编程艺术）
- Doug Mcilroy:
1.让每个程序就做好一件事。如果有新任务，就重新开始，不要往原程序中加入新功能而搞得复杂。
2.假定每个程序的输出都会成国另一个程序的输入，哪怕那个程序还是未知的。输出中不要有无关的信息干扰。避免使用严格的分栏格式和二进制格式输入。不要坚持使用交互式输入。
3.尽可能早地将设计和编译的软件投入试用，哪怕是操作系统也不例外，理想情况下，应该是在几星期之内。对拙劣的代码别犹豫，扔掉重写。
4.优先使用工具而不是拙劣的帮助来减轻编程的负担。工欲善其事，必先利其器。
5.一个程序只做一件事，并做好。程序要能协作。程序要能处理文本流，因为这是最通用的接口。
- Rob Pike:
1.你无法断定程序会在什么地方耗费运行时间。瓶颈经常出现在想不到的地方，所以别急于胡找个地方改代码，除非你已证实那儿就是瓶颈所在。
2.估量。在你没对代码进行估量，特别是没找到最耗时的那部分之前，别去优化速度。
3.花哨的算法在n很小时通常很慢，而n通常很小。花哨算法的常数复杂度很大。除非你确定n总是很大，否则不要用花哨算法（即使n很大，也优先考虑第2条）
4.花哨的算法比简单算法更容易出bug、更难实现。尽量使用简单的算法配合简单的数据结构。
5.数据压倒一切。如果已经选择了正确的数据结构并具把一切都组织得井井有条，正确的算法也就不言自明。编程的核心是数据结构，而不是算法。
给我看流程图而不让我看（数据）表，我仍会茫然不解；如果给我看（数据）表，通常就不需要流程图了；数据表足够说明问题了。
6.原则6：没有原则6
- Ken Thompson:
模块原则：使用间洁的接口拼合简单的部件。
清晰原则：清晰胜于机巧。
拿不准就穷举。
组合原则：设计时考虑拼接组合。
分离原则：策略同机制分离，接口同引擎分离。
简洁原则：设计要简洁，复杂度能低则低。
吝啬原则：除非确无它法，不要编写宠大的程序。
透明性原则：设计要可见，以便审查和调试。
健壮原则：健壮源于透明与简洁。
表示原则：把知识叠入数据以求逻辑质朴与健壮。
通俗原则：接口设计避免标新立异。
缄默原则：如果一个程序没什么好说的，就沉默。
补救原则：也现异常时，马上退也并给出足够错误信息。
经济原则：宁花机器一分钟，不花程序员一秒钟。
生成原则：避免手工hack，尽量编写程序去生成程序。
优化原则：雕琢前先要有原型，跑之前先学会走。
多样原则：决不相信所谓“不二法门”的断言。
扩展原则：设计着眼未来，未来部比预想来得快。
补充资源
- PHP 微服务系列大纲
- PHP 网络编程基础 - swoole
- swoole| swoole wiki 笔记
PHP 微服务框架
云平台基础设施
