构建自己的PHP框架--抽象框架的内容
上一篇博客中,我们搭建了一个最简单的框架,从单一入口的public/index.php进入,解析出相应的Controller和Action,去执行,渲染出相应的页面或者输出相应的数据。
但是我们可以看到在public/index.php文件中,是一堆代码,如果之后,我要添加权限/事件等等的机制是不是也要也在这里,那不难想象,不就的将来,index.php就会变成一个巨大无比的php文件。我们当然不想看到这样的情景,所以我们需要将这些内容抽象出来,保持入口文件的简单明了。
那我们要将这些内容抽象到那里去呢?有聪明的同学已经想到了,就是之前在composer.json中定义的位置,我们来看一下composer.json文件:
<span style="color: #000000;">{ </span>"name": "craryprimitiveman/simple-framework"<span style="color: #000000;">, </span>"description": "A simple php framework"<span style="color: #000000;">, </span>"license": "MIT"<span style="color: #000000;">, </span>"authors"<span style="color: #000000;">: [ { </span>"name": "harrysun"<span style="color: #000000;">, </span>"email": "[email protected]"<span style="color: #000000;"> } ], </span>"require"<span style="color: #000000;">: {}, </span>"autoload"<span style="color: #000000;">: { </span>"psr-4"<span style="color: #000000;">: { </span>"sf\\": "src/"<span style="color: #000000;">, </span>"app\\": ""<span style="color: #000000;"> } }, </span>"repositories"<span style="color: #000000;">: [ {</span>"type": "composer", "url": "http://packagist.phpcomposer.com"<span style="color: #000000;">}, {</span>"packagist": <span style="color: #0000ff;">false</span><span style="color: #000000;">} ]}</span>
可以看到autoload里的psr-4里还有个sf\\,他的地址是src/,这就是我们要放抽象出的内容的地方。
有人会问,为什么不直接使用app\\ 作为namespace呢?因为想到之后要将src下的内容做成一个composer包,迁移到vendor中。
下面就正式开始抽象了。
在src下创建两个文件夹,一个是base,一个是web。base用来存放基础的类,web用来存放与web相关的类。因为将来框架可能还要支持php脚本的执行,所以要将base和web分开,将来要加php脚本时,只需要建立一个console的文件夹就好了。
在两个文件夹中分别建立Application.php文件。
先来看在base里的Application.php
<?<span style="color: #000000;">phpnamespace sf\base;</span><span style="color: #0000ff;">use</span> <span style="color: #0000ff;">Exception</span><span style="color: #000000;">;</span><span style="color: #008000;">/*</span><span style="color: #008000;">* * Application is the base class for all application classes. * @author Harry Sun <[email protected]> <span style="color: #008000;">*/</span><span style="color: #0000ff;">abstract</span> <span style="color: #0000ff;">class</span><span style="color: #000000;"> Application{ </span><span style="color: #008000;">/*</span><span style="color: #008000;">* * @var string the namespace that controller classes are located in. * This namespace will be used to load controller classes by prepending it to the controller class name. * The default namespace is `app\controllers`. </span><span style="color: #008000;">*/</span> <span style="color: #0000ff;">public</span> <span style="color: #800080;">$controllerNamespace</span> = 'app\\controllers'<span style="color: #000000;">; </span><span style="color: #008000;">/*</span><span style="color: #008000;">* * Runs the application. * This is the main entrance of an application. </span><span style="color: #008000;">*/</span> <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span><span style="color: #000000;"> run() { </span><span style="color: #0000ff;">try</span><span style="color: #000000;"> { </span><span style="color: #0000ff;">return</span> <span style="color: #800080;">$this</span>-><span style="color: #000000;">handleRequest(); } </span><span style="color: #0000ff;">catch</span> (<span style="color: #0000ff;">Exception</span> <span style="color: #800080;">$e</span><span style="color: #000000;">) { </span><span style="color: #0000ff;">return</span> <span style="color: #800080;">$e</span><span style="color: #000000;">; } } </span><span style="color: #008000;">/*</span><span style="color: #008000;">* * Handles the specified request. </span><span style="color: #008000;">*/</span> <span style="color: #0000ff;">abstract</span> <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span><span style="color: #000000;"> handleRequest();}</span>
它是一个抽象类,实现了一个简单的run方法,run方法就是去执行以下handleRequest方法。
它定义了一个抽象方法handleRequest,等待被继承,实现。
它定义了一个controllerNamespace属性,记录controller存放的namesapce,默认值是'app\\controllers'。
再来看在web里的Application.php
<?<span style="color: #000000;">phpnamespace sf\web;</span><span style="color: #008000;">/*</span><span style="color: #008000;">* * Application is the base class for all application classes. * @author Harry Sun <[email protected]> <span style="color: #008000;">*/</span><span style="color: #0000ff;">class</span> Application <span style="color: #0000ff;">extends</span><span style="color: #000000;"> \sf\base\Application{ </span><span style="color: #008000;">/*</span><span style="color: #008000;">* * Handles the specified request. * @return Response the resulting response </span><span style="color: #008000;">*/</span> <span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span><span style="color: #000000;"> handleRequest() { </span><span style="color: #800080;">$router</span> = <span style="color: #800080;">$_GET</span>['r'<span style="color: #000000;">]; </span><span style="color: #0000ff;">list</span>(<span style="color: #800080;">$controllerName</span>, <span style="color: #800080;">$actionName</span>) = <span style="color: #008080;">explode</span>('/', <span style="color: #800080;">$router</span><span style="color: #000000;">); </span><span style="color: #800080;">$ucController</span> = <span style="color: #008080;">ucfirst</span>(<span style="color: #800080;">$controllerName</span><span style="color: #000000;">); </span><span style="color: #800080;">$controllerName</span> = <span style="color: #800080;">$this</span>->controllerNamespace . '\\' . <span style="color: #800080;">$ucController</span> . 'Controller'<span style="color: #000000;">; </span><span style="color: #800080;">$controller</span> = <span style="color: #0000ff;">new</span> <span style="color: #800080;">$controllerName</span><span style="color: #000000;">(); </span><span style="color: #0000ff;">return</span> <span style="color: #008080;">call_user_func</span>([<span style="color: #800080;">$controller</span>, 'action'. <span style="color: #008080;">ucfirst</span>(<span style="color: #800080;">$actionName</span><span style="color: #000000;">)]); }}</span>
是不是觉得很眼熟,其实就是将之前放在index.php中的内容放到Application的handleRequest方法里了。
然后我们需要从入口文件调用到这里的代码,这就很简单了,index.php的内容如下:
<?<span style="color: #000000;">php</span><span style="color: #0000ff;">require_once</span>(__DIR__ . '/../vendor/autoload.php'<span style="color: #000000;">);</span><span style="color: #800080;">$application</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> sf\web\Application();</span><span style="color: #800080;">$application</span>->run();
直接去new一个web Application的实例,执行run方法就可以了,是不是很简单。
访问一下:http://localhost/simple-framework/public/index.php?r=site/test,你可以看到上一次一样的结果。
好了,今天就先到这里。项目内容和博客内容也都会放到Github上,欢迎大家提建议。
code:https://github.com/CraryPrimitiveMan/simple-framework/tree/0.2
blog project:https://github.com/CraryPrimitiveMan/create-your-own-php-framework