dotenv 2到3版本设计模式重构实战分析

老大说了这个dotenv的重构比较适合用来学习,进行了分析,并分享了出来php

github项目地址: github.com/vlucas/phpd…git

dotenv是一个php写的从文件中加载环境变量的库,库自己文件数量较少,比较容易阅读。github

核心api变更

2.x实例化方式设计模式

$dotenv = new Dotenv\Dotenv(__DIR__, 'myconfig');
$dotenv->load();
复制代码

3.x实例化方式api

$dotenv = Dotenv\Dotenv::create(__DIR__, 'myconfig');
$dotenv->load();
复制代码

静态工厂方法设计模式应用

这个3.x版本create方法建立对象使用的是工厂方法设计模式数组

核心实例化dotenv对象由手动调用构造方法重构成了静态工厂方法,这个改变是由于这个dotenv加载.env文件须要判断env文件、envFactory对象是否传递,而这个判断是个if else的逻辑,根据构造方法不宜写逻辑定理,若是不使用静态工厂方法进行重构,那么在new DotEnv以前,必须手动判断.env是否存在。在屡次实例化这个Dotenv对象时,必然形成代码重复。工具

经过工厂方法封装建立对象的逻辑,以免建立对象的代码重复,是很是常见的一种设计模式的最佳实践学习

静态方法封装的逻辑

每次建立dotenv实例省掉的这部分代码量仍是至关客观的,而且建立的逻辑统一到这一处了,也提升了维护可维护性

目录结构分析

能够看到核心目录3.x比2.x多了Environment和Regex目录 核心文件3.x比2.x多了Lines.php,查看 lins.php,能够看到里面所有是静态工具方法

异常3.x比2.x多了InvalidCallbackExceptionspa

env文件加载-适配器设计模式应用实战

3.x比2.x重要的改变是多了Adapter目录,这个是由于2.x仅支持将.env使用putenv加载到环境变量中,而3.x支持将.env加载到多个环境变量中,包括设计

  1. putenv加载到应用环境变量中
  2. array加载到数组中
  3. 加载到$_ENV全局变量中
  4. 加载到$_SERVER全局变量中 能够看到3.x支持设置的目标更多了,可是这4钟加载方式实际执行的代码并不相同,dotenv为了可以统一这四种加载方式的接口,使用了适配器模式进行统一适配成了AdapterInterface接口

每一个适配都实现这个接口

在使用时就能无差异对待了,这样无需调用时候的if else判断了

DotenvVariables.php#L81

一些注意的点

接口可替换设计

dotenv库一共包含4个接口

  1. AdapterInterface
  2. FactoryInterface
  3. VariablesInterface
  4. ExceptionInterface

这些接口都是可替换的,这种面向接口的设计方式使得代码很是容易扩展

参考资料

  1. github.com/vlucas/phpd…
  2. github.com/vlucas/phpd…
相关文章
相关标签/搜索