94hwan-PHP框架基本原理

Source:94hwan 与众不同  Author:网络部
2011-09-20 14:11

一、初始化過程
1、94hwan-PHP框架的入口点都是加载根目录的 init.php 来初始化的,因此在这里主要介绍一下初始化时到底做了一些什么。

  1. // 嚴格開發模式 
  2. error_reporting( E_ALL ); 
  3.  
  4. //開啓register_globals會有諸多不安全可能性,因此強制要求關閉register_globals 
  5. if ( ini_get('register_globals') ) 
  6.     exit('php.ini register_globals must is Off! '); 
  7.  
  8. //核心庫目錄 
  9. define('CORE', dirname(__FILE__)); 
  10.  
  11. //系統配置 
  12. require CORE.'/../config/inc_config.php'
  13.  
  14. //外部請求程序處理(路由) 
  15. require CORE.'/req.php'
  16. req::init(); 
  17.  
  18. //設置時區 
  19. date_default_timezone_set( $GLOBALS['config']['timezone_set'] ); 
  20.  
  21. //加載核心類庫 
  22. require CORE.'/util.php'
  23. require CORE.'/db.php'
  24. require CORE.'/tpl.php'
  25. require CORE.'/log.php'
  26. require CORE.'/cache.php'
  27.  
  28. //debug設置 
  29. $_debug_safe_ip = false; 
  30. require PATH_LIBRARY.'/debug/lib_debug.php'
  31. if( in_array( util::get_client_ip(), $GLOBALS['config']['safe_client_ip']) || OPEN_DEBUG === true ) 
  32.     $_debug_safe_ip = true; 
  33.     ini_set('display_errors''On'); 
  34. else 
  35.     ini_set('display_errors''Off'); 
  36. set_exception_handler('handler_debug_exception'); 
  37. set_error_handler('handler_debug_error', E_ALL); 
  38. register_shutdown_function('handler_php_shutdown'); 
  39.  
  40. //session接口(使用session前需自行調用session_start) 
  41. require CORE.'/session.php'
  42.  
  43. /** 
  44.  * 程序結束後執行的動作 
  45.  */ 
  46. function handler_php_shutdown() 
  47.     show_debug_error(); 
  48.     log::save(); 
  49.     if( defined('CLS_CACHE') ) { 
  50.         cache::free(); 
  51.     } 
  52.     if( defined('CLS_CACHE_NATIVE') ) { 
  53.         cls_cache_native::close(); 
  54.     } 
  55.  
  56. /** 
  57.  * 致命錯誤處理接口 
  58.  * 系統發生致命錯誤後的提示 
  59.  * (致命錯誤是指發生錯誤後要直接中斷程序的錯誤,如數據庫連接失敗、找不到控制器等) 
  60.  */ 
  61. function handler_fatal_error( $errtype$msg ) 
  62.     global $_debug_safe_ip
  63.     $log_str = $errtype.':'.$msg
  64.     if ( OPEN_DEBUG === true || $_debug_safe_ip ) 
  65.     { 
  66.         throw new Exception( $log_str ); 
  67.     } 
  68.     else 
  69.     {         
  70.         log::add('fatal_error'$msg); 
  71.         header ( "location:/404.html" ); 
  72.         exit(); 
  73.     } 
  74.  
  75. /** 
  76.  * 路由控制 
  77.  * 
  78.  * @param $ctl  控制器 
  79.  * @parem $ac   動作 
  80.  * @return void 
  81.  */ 
  82. function run_controller() 
  83.     try 
  84.     { 
  85.         $ac = preg_replace("/[^0-9a-z_]/i"'', req::item('ac''index') ); 
  86.         $ac = emptyempty ( $ac ) ? $ac = 'index' : $ac
  87.              
  88.         $ctl = 'ctl_'.preg_replace("/[^0-9a-z_]/i"'', req::item('ct''index') ); 
  89.         $path_file = PATH_CONTROL . '/' . $ctl . '.php'
  90.  
  91.         iffile_exists$path_file ) ) 
  92.         { 
  93.             require $path_file
  94.         } 
  95.         else 
  96.         { 
  97.             throw new Exception ( "Contrl {$ctl}--{$path_file} is not exists!" ); 
  98.         } 
  99.         if( method_exists ( $ctl$ac ) === true ) 
  100.         { 
  101.             $instance = new $ctl ( ); 
  102.             $instance->$ac (); 
  103.         } 
  104.         else 
  105.         { 
  106.             throw new Exception ( "Method {$ctl}::{$ac}() is not exists!" ); 
  107.         } 
  108.     } 
  109.     catch ( Exception $e ) 
  110.     { 
  111.         handler_fatal_error( 'init.php run_controller()'$e->getMessage().' url:'.util::get_cururl() ); 
  112.     } 
  113.  
  114. /** 
  115.  * 自動加載類庫處理 
  116.  * 加載優先級 /core/library => 應用目錄/model => 根目錄/model 
  117.  * (如果不在這些位置, 則需自行手工加載,對于小型項目,也可以把model全放到library以減少類文件查找時間) 
  118.  * @return void 
  119.  */ 
  120. function __autoload( $classname ) 
  121.     $classname = preg_replace("/[^0-9a-z_]/i"''$classname); 
  122.     ifclass_exists ( $classname ) ) { 
  123.         return true; 
  124.     } 
  125.     $classfile = $classname.'.php'
  126.     try 
  127.     { 
  128.         if ( file_exists ( PATH_LIBRARY.'/'.$classfile ) ) 
  129.         { 
  130.             require PATH_LIBRARY.'/'.$classfile
  131.         } 
  132.         else iffile_exists ( PATH_MODEL.'/'.$classfile ) )  
  133.         { 
  134.             require PATH_MODEL.'/'.$classfile
  135.         } 
  136.         else iffile_exists ( require PATH_ROOT.'/model/'.$classfile ) )  
  137.         { 
  138.             require PATH_ROOT.'/model/'.$classfile
  139.         } 
  140.         else 
  141.         { 
  142.             return false; 
  143.             throw new Exception ( 'Error: Cannot find the '.$classname ); 
  144.         } 
  145.     } 
  146.     catch ( Exception $e ) 
  147.     { 
  148.         handler_fatal_error( 'init.php __autoload()'$e->getMessage().'|'.$classname.' url:'.util::get_cururl() ); 
  149.     } 
  150.  
  151. /** 
  152.  * req::item 別名函數 
  153.  */ 
  154. function request($key$df=''
  155.     return req::item($key$df); 

說明一:新版框架最大的不同之處是,在引導文件裏引入了重新封裝過幾個重要核心類,這些東西加起來,其實就是組成了最迷你的一個框架,但是功能少卻基本完全兼顧,包括下面幾個方面:
(1) 路由功能req.php:即是全局環境檢查與請求參數初始化;
(2) 基本数据库类db.php:因爲數據庫類是最常用的的類,因此名稱跳出規範的標准,直接使用db作爲名稱,更便于記憶;
(3) 视图类tpl.php:视图类是MVC框架里不可缺少的东西,本框架通过对smarty进行简化封装后,得到的 tpl 类,即是相当于别的框架的视图对应的功能;
(4) 缓存类cache.php:支持本地单文件hash缓存和memcache缓存,取代原来memcache + 打散文件的模式(这种模式缺点是时间长之后文件碎片极多,造成维护困难);
(5) 日志类log.php:目前僅進行了簡單的規範;
(6) 调试程序debug/lib_debug.php:引導文件中定義了debug的方案並且定義了register_shutdown_function接口。
(7) session(sesion.php):重寫了session接口,確保在各種場合下都可以使用session。
(8) 引导功能:定義了如何引導到控制器和加載類庫路徑(un_controller、__autoload)。

說明二:通過分析上面入口源碼,必須重點清楚幾個事情:
(1)、傳入系統的請求參數都是已經轉義的,如果需要用到不轉義的情況,需要還原後使用;
(2)、对于_GET、_POST、_FILES ,不要再使用原来的操作方法,而是使用 req类去操作(具体可以参考类文档);
(3)、/core/library 目录存放的是系统基础类和公共类文件,不要存放 mod_*.php(如果是很小的项目则没关系),公共接口类要存放这个位置的用 pub_*.php 命名,普通模型类应该存放在 应用目录/model 文件夹,并命名为 mod_*.php (私有逻辑类编程规范里要求用静态成员方法)。

2、分析入口文件 index.php 这里分别把 /index.php 和 admin/index.php 列出来,对比这它们的不同
/index.php

  1. <?php 
  2. header('Content-Type: text/html; charset=utf-8'); 
  3. $page_start_time = microtime(true); 
  4.  
  5. require './init.php'
  6.  
  7. $config_pool_name = $config_appname  =  $config_cp_url = ''
  8.  
  9. execute_ctl(req::$forms['ct'], req::$forms['ac']); 
  10.  
  11. ?> 

admin/index.php

  1. <?php 
  2. header('Content-Type: text/html; charset=utf-8'); 
  3. $page_start_time = microtime(true); 
  4.  
  5. require '../init.php'
  6.  
  7. $config_pool_name = 'administrator';       //應用池參數(與權限管理有關) 
  8.  
  9. $config_appname   = 'admin';       //應用名稱(與模板文件夾有關,不一定與應用池名稱一致) 
  10.  
  11. $config_cp_url = '?ct=index&ac=login';     //用于未登錄用戶跳轉到的url 
  12. cls_template::assign('URL', URL); 
  13.  
  14. //前置的權限控制器 
  15. $config_access_ctl = cls_access::factory( $config_pool_name$config_cp_url ); 
  16. $config_access_ctl->test_purview( req::$forms['ct'], req::$forms['ac'], '1' ); 
  17.  
  18. execute_ctl( req::$forms['ct'], req::$forms['ac'] ); 
  19. ?> 

通过对比,不难看出,admin 目录的入口文件与根目录相比,主要多了如下代码:
$config_pool_name = 'administrator';       //應用池參數(與權限管理有關)
$config_appname   = 'admin';       //應用名稱(與模板文件夾有關,不一定與應用池名稱一致)
$config_cp_url = '?ct=index&ac=login';     //用于未登錄用戶跳轉到的url
//前置的權限控制器
$config_access_ctl = cls_access::factory( $config_pool_name, $config_cp_url );
$config_access_ctl->test_purview( req::$forms['ct'], req::$forms['ac'], '1' );

上面的代码实际上就是权限控制类的代码,权限控制类通过监听 ct  和  ac 实现对权限的控制的,权限类里对角色分两种情况处理,一种是组权限,在没指定用户具体权限的情况下,通过组权限配置来识别用户权限,在指定了用户具体权限的情况下,以指定的独立权限为准。

此外,细心的人可能会发现 $forms['ct'], $forms['ac'] 居然没预先判断是否存在,实际上其实在 req 类中,对ct和ac为空的情况会默认赋值为 index,当然如果是其它变量,用:
req::item(formName, 默认值)   或直接使用 request(formName, 默认值)
這樣獲取即可。

二、程序運行過程
通过分析源码,不难知道,程序最终要调用的文件和执行的类及方法,主要在 run_controller() 这函数里处理。
它的源碼如下:

  1. /** 
  2.  * 路由控制 
  3.  * 
  4.  * @param $ctl  控制器 
  5.  * @parem $ac   動作 
  6.  * @return void 
  7.  */ 
  8. function run_controller() 
  9.     try 
  10.     { 
  11.         $ac = preg_replace("/[^0-9a-z_]/i"'', req::item('ac''index') ); 
  12.         $ac = emptyempty ( $ac ) ? $ac = 'index' : $ac
  13.              
  14.         $ctl = 'ctl_'.preg_replace("/[^0-9a-z_]/i"'', req::item('ct''index') ); 
  15.         $path_file = PATH_CONTROL . '/' . $ctl . '.php'
  16.  
  17.         iffile_exists$path_file ) ) 
  18.         { 
  19.             require $path_file
  20.         } 
  21.         else 
  22.         { 
  23.             throw new Exception ( "Contrl {$ctl}--{$path_file} is not exists!" ); 
  24.         } 
  25.         if( method_exists ( $ctl$ac ) === true ) 
  26.         { 
  27.             $instance = new $ctl ( ); 
  28.             $instance->$ac (); 
  29.         } 
  30.         else 
  31.         { 
  32.             throw new Exception ( "Method {$ctl}::{$ac}() is not exists!" ); 
  33.         } 
  34.     } 
  35.     catch ( Exception $e ) 
  36.     { 
  37.         handler_fatal_error( 'init.php run_controller()'$e->getMessage().' url:'.util::get_cururl() ); 
  38.     } 


这个函数是通过控制器名称来确定要调用的 control  类文件,并且,初始化这个类,并调用里面的 action(ac) 方法。

PATH_CONTROL == './control'

在上面源碼有,有一處語法:empty ( $action ) && $action = 'index';
這種語法是不規範的,倒不是說不合乎PHP標准,而是不具可讀性,對于沒用過這種方式的人,讀起來會很費勁,過于個性化,這是曆史留下來的問題,這裏我不作修改,讓後來人作爲反面參考教材。
 

通過分析源碼,相信大家都能明白在94hwan框架下是如何進行開發的了,其實主要是兩個方面:
1、URL里的ct 和 ac 表示指向 control/ct_ctname.php 里的 action(ac) 方法,开发人员的工作就是写这个ct类和ac方法,但需要注意的是控制器只负责的用户请求进行控制,逻辑代码应该放在 model 目录的相应类, 或 library 里的框架基础类或项目接口类, 除了lurd类之外,尽量不要在 ac 类直接操作数据库,过于复杂的代码都要封装为逻辑类。
2、框架要求对 GET、POST、FILES 请求都用 req 类,因此,开发前必须先完全弄明白这个类的使用方法。

 

...