php类自动加载

rare内置了类自动装载功能，当使用一个类的使用直接使用而无须require(include) 类文件。

该类自动装载功能非常的独立，若你需要，可以直接在其他框架(任意php程序)中使用。

1.先引入 rareAutoLoad.class.php

2.注册功能

1. /**
2. * 类自动装载
3. * http://raremvc.googlecode.com
4. * http://rare.hongtao3.com
5. * @example
6. * include 'rareAutoLoad.php';
7. * $option=array('dirs'=>'/www/lib/share/,/www/lib/api/',//class 从那些目录中查找
8. * 'cache'=>'/tmp/111111.php',//class path 缓存文件
9. * ‘suffix’=>'.class.php' //需要类自动装载的php类文件的后缀
10. * "hand"=>true, //是否手动更新class 路径文件 ，为false 时 缓存文件写入到指定的cache文件中去，
11. * //为true 是需要手动允许 autoLoad.php 文件
12. * );
13. * rareAutoLoad::register($option);
14. *
15. * 参考了symfony 的类自动装载
16. * 为了提供效率，将类的位置保存到缓存文件中，在第一次使用的时候会对dirs中的文件目录进行扫描
17. * 需要自动装载的类的文件命名 要求 必须 以 .class.php 结束，如文件名为 a.class.php 中定义的类可以被扫描到而 a.php的文件会忽略掉
18. * 类名 和 文件命名 可以没有关系 如 a.class.php 文件中 可以定义 class b{}
19. *
20. * @author duwei
21. *
22. */
23. class rareAutoLoad
24. {
25. private static $instance=null;
26. private static $registered=false;
28. private $cacheFile=null;
29. private $classes=array();//对应class 类名 和对应文件路径
30. private $option;
32. private $hand=false;//是否手动运行该脚本进行class路径扫描,
34. private $reloadCount=0;//reload操作的次数
35. /**
36. * @param array $option 需要参数 dirs：扫描目录 cache：缓存文件
37. */
38. public function __construct($option){
40. if(!isset($option['suffix'])) $option['suffix']=".class.php";//文件后缀
41. $this->option=$option;
42. if(!isset($option['cache'])){
43. $trac=debug_backtrace(false);
44. $calFile=$trac[2]['file'];
45. $option['cache']="/tmp/rareautoLoad_".md5($calFile)."_".filemtime($calFile);
46. @unlink($option['cache']);
47. }
48. if(isset($option['hand']))$this->hand=(boolean)$option['hand'];
49. $this->cacheFile=$option['cache'].".php";
50. $this->getClasses();
51. }
53. /**
54. * 获取DAutoLoad 的单实例对象
55. * @param array $option
56. * @return DAutoLoad
57. */
58. private static function getInstance($option){
59. if (!isset(self::$instance)){
60. self::$instance = new rareAutoLoad($option);
61. }
62. return self::$instance;
63. }
65. /**
66. * 注册自动装载
67. * @param array $option array('dirs'=>'/www/lib/share/,/www/lib/api/','cache'=>'/tmp/111111.php');
68. * @throws Exception
69. */
70. public static function register($option) {
71. if (self::$registered)return;
72. // ini_set('unserialize_callback_func', 'spl_autoload_call');
73. if (false === spl_autoload_register(array(self::getInstance($option), 'autoload'))){
74. die(sprintf('Unable to register %s::autoload as an autoloading method.', get_class(self::getInstance())));
75. }
76. self::$registered = true;
77. }
79. /**
80. * spl_autoload_call 调用 load class
81. * 若缓存文件中的类的路径不正确，会尝试reload一次
82. * 对reload后还不存在的类 缓存中记录其key，标记为 false,以避免缓存文件多次无效的更新
83. * 对于使用 class_exists 进行判断时默认会进行autoload操作
84. * @param $class
85. * @return
86. */
87. public function autoload($class){
88. if(class_exists($class, false) || interface_exists($class, false)) return true;
89. if ($this->classes && isset($this->classes[$class]) ){
90. $file=$this->classes[$class];
91. if(!$file)return false;
92. if(!file_exists($file) && !$this->hand){
93. $this->reload();
94. return $this->autoload($class);
95. }
96. require($file);
97. return true;
98. }{
99. $this->reload();
100. if(isset($this->classes[$class])){
101. $file=$this->classes[$class];
102. if(!$file)return false;
103. require($file);
104. return true;
105. }else{
106. $this->classes[$class]=false;
107. $this->saveCache();
108. }
109. }
110. return false;
111. }
112. /**
113. * 获取类名列表
114. * @return
115. */
116. private function getClasses(){
117. if(file_exists($this->cacheFile)){
118. $this->classes=require($this->cacheFile);
119. if(is_array($this->classes))return true;
120. }
121. $this->classes=array();
122. $this->reload();
123. }
125. /**
126. * 重新扫描一次
127. * 并将类名的位置信息保存到cache 中
128. * @return
129. */
130. private function reload(){
131. $this->reloadCount++;
132. if($this->hand)return;
133. $cachedir=dirname($this->cacheFile);
134. $this->directory($cachedir);
135. if(!is_writable($cachedir)) die('can not write cache!');
137. settype($this->classes, 'array');
139. $dirs=$this->option['dirs'];
140. if(!is_array($dirs)) $dirs=explode(",", $dirs);
142. $dirs=array_unique($dirs);
143. foreach($dirs as $dir){
144. if(!$dir || !file_exists($dir))continue;
145. $this->scanDir($dir);
146. }
147. $this->saveCache();
148. }
150. private function saveCache(){
151. if($this->hand)return;
152. $phpData=" if(!is_array($this->classes))$this->classes=array();
153. ksort($this->classes);
154. $phpData.="return ".var_export($this->classes,true).";";
155. file_put_contents($this->cacheFile, $phpData,LOCK_EX);
156. clearstatcache();
157. }
159. /**
160. * 扫描文件夹以及文件
161. * 只有 $this->option['suffix'] 命名的文件才会被扫描到
162. * @param $dir
163. * @return
164. */
165. private function scanDir($dir){
166. $files=scandir($dir,1);
167. foreach($files as $fileName){
168. $file=rtrim($dir,DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$fileName;
169. if(is_dir($file) && strpos($fileName,'.')!==0){
170. $this->scanDir($file);
171. }else{
172. if($this->str_endWith($fileName,$this->option['suffix'])){
173. preg_match_all('~^\s*(?:abstract\s+|final\s+)?(?:class|interface)\s+(\w+)~mi', file_get_contents($file), $classes);
174. foreach ($classes[1] as $class){
175. $this->classes[$class] = $file;
176. }
177. }
178. }
179. }
180. }
182. private function directory($dir){
183. return is_dir($dir) or ($this->directory(dirname($dir)) and mkdir($dir, 0777));
184. }
186. function str_endWith($str,$subStr){
187. return substr($str, -(strlen($subStr)))==$subStr;
188. }
189. }