手写实现php极简框架项目

1、项目简介

2、项目结构

2.1 文件结构图

App
|----Console
!----|----Base.php
|----|----Advt
|----|----Mysql
|----|----Mongo
|----|----Redis
...
|----Controller
!----|----Base.php
|----|----Index
|----|----User
...
|----Response
|----Constant
|----Func
|----Lib
|----Logic
|----|----Advt
...
|----Model
!----AbstractModel.php
|----|----User
...
|----Service
|----|----Mongo
|----|----|----BaseService.php
...
|----|----User
...
|----Task
|----|----BaseTask.php
...
config
statics
composer.json
console.php
index.php

2.2 结构详解

2.2.1 根目录文件:

2.2.2 应用目录文件:

2.2.2.1 Controller:

<?php
namespace App\Controller\Student;
use Context;
use App\Controller\Base;
use App\Response\Response;
class IndexController extends Base{
 
 public function IndexAction(){
 $sid = $this->params['id']?:1;
 return Context::get(Response::class)->success(
 'hello,student', 
 [
 'sid' => $sid
 ]
 );
 }
}

2.2.2.2 Console:

<?php
namespace App\Console\MySql;
use App\Console\Base;
use App\Func\Config;
use Illuminate\Database\Capsule\Manager as DB;
class TestMysql extends Base{
 public function run(){
 $db = Config::get('db');
 var_dump($db);
 $group = DB::table('group')->where('id','>',1)->get();
 var_dump($group);
 }
}

2.2.2.3 公共模块:

3、代码解析

3.1、自动任务执行流程

<?php
define("PROJECT_PATH",str_replace(str_replace("\\","/",__NAMESPACE__),"",__DIR__));
define("CONSOLE_PATH",PROJECT_PATH.DIRECTORY_SEPARATOR."App".DIRECTORY_SEPARATOR."Console".DIRECTORY_SEPARATOR);
/**
 * @usage php console.php r=Mysql/TestMysql
 */
class Application {
 public $route;
 public $argv;
 public $defaultns = "App\\Console\\";
 public function __construct($argv){
 $this->argv = $argv;
 }
 public function getParams() {
 $params = [];
 array_shift($this->argv);
 foreach ($this->argv as $k => $v) {
 $tmpArr = explode("=", $v);
 $params[reset($tmpArr)] = end($tmpArr);
 }
 return $params;
 }
 public function parseRoute() {
 $this->route = explode("/",$this->getParams()['r']??'');
 if (empty($this->route)) exit("router r is required ! r=xx");
 
 array_walk($this->route ,function(&$itm) {
 $itm = ucfirst($itm);
 });
 }
 public static function useImplode($separator,$arr) {
 $str = "";
 foreach($arr as $k => $v) {
 $str.= sprintf("%s%s",$v, $k==count($arr)-1 ? "" : $separator);
 }
 return $str;
 }
 //auto_laod class
 public function loadClass() {
 
 require_once CONSOLE_PATH."Base.php";
 require_once CONSOLE_PATH. self::useImplode(DIRECTORY_SEPARATOR,$this->route).".php";
 }
 public function getInstance(){
 $className = sprintf("%s%s",$this->defaultns,self::useImplode("\\",$this->route));
 return new $className($this->argv);
 }
 public function start() {
 $this->parseRoute();
 $this->loadClass();
 return $this->getInstance()->run();
 }
}
$app = new Application($argv);
$app->start();

php console.php r=Mysql/TestMysql

<?php 
namespace App\Console;
//设置全局常量
define("ROOT_PATH",str_replace(str_replace("\\","/",__NAMESPACE__),"",__DIR__));
define("BASE_PATH",ROOT_PATH.DIRECTORY_SEPARATOR."App".DIRECTORY_SEPARATOR."Console".DIRECTORY_SEPARATOR);
define("STATIC_PATH",ROOT_PATH."statics");
define('APPLICATION_ENV', $_ENV['SERVER_ENV'] ?? 'test');
use App\Func\Config;
use App\Func\MongoTool;
use App\Func\RedisTool;
use Illuminate\Database\Capsule\Manager as DB;
abstract class Base {
 public $params;
	public $basePath;
	abstract public function run();
 public function __construct($argv) {
		$this->params = $this->getParams($argv);
		$this->basePath = $this->getBasePath();		
		$this->bootstrap();
 }
	public function bootstrap() {
		$this->autoLoadClass();
		$this->loadConfig();
		$this->loadDB();
		$this->loadCache();
		$this->loadMongo();
	}
 public function getParams($argv) {
		$params = [];
		array_shift($argv);
		foreach ($argv as $k => $v) {
			$tmpArr = explode("=", $v);
			$params[reset($tmpArr)] = end($tmpArr);
		}
		return $params;
	}
	public function getBasePath() {
		 return ROOT_PATH;
	}
	public function autoLoadClass() {
		//自动加载第三方扩展类库
		require_once ROOT_PATH.'vendor/autoload.php';
		//自动加载命名空间下扩展库
		spl_autoload_register(function($className)
		{
			$currentFile = $this->basePath. str_replace("\\","/",$className) .".php";
			//echo "try to auto load ".$currentFile.PHP_EOL;
			if (file_exists($currentFile)) {
				require_once "{$currentFile}";
			} else{
				throw new \Exception("class {$className} is not exist!");
			}
		});
	}
	public function loadConfig(){
		$confPath = $this->basePath."config".DIRECTORY_SEPARATOR;
		$baseData = require_once $confPath."config.php";
		$envData = require_once $confPath.APPLICATION_ENV.".php";
		Config::set(array_merge($baseData,$envData));
	}
	public function loadDB(){
		$db = new DB;
		$dbConf = Config::get('db')['mysql'];
		$db->addConnection([
			'driver' => $dbConf['driver'],
			'host' => $dbConf['host'],
			'database' => $dbConf['database'],
			'username' => $dbConf['user'],
			'password' => $dbConf['pwd'],
			'charset' => 'utf8',
			'collation' => 'utf8_unicode_ci',
			'prefix' => $dbConf['prefix'],
		]);
		$db->setAsGlobal();
		$db->bootEloquent();
	}
	public function loadCache(){
		$rdsConf = Config::get('redis');
		RedisTool::connect($rdsConf);
	}
	public function loadMongo(){
		$mongoConf = Config::get('mongo'); 
		MongoTool::connect($mongoConf);
	}
 
}

3.2、控制器执行流程

<?php
define("PROJECT_PATH",str_replace(str_replace("\\","/",__NAMESPACE__),"",__DIR__));
define("CONTROL_PATH",PROJECT_PATH.DIRECTORY_SEPARATOR."App".DIRECTORY_SEPARATOR."Controller".DIRECTORY_SEPARATOR);
/**
 * @stat php index.php 
 * @http http://127.0.0.1:9001/?r=Index/Index/Index&uid=1
 */
use \Swoole\Http\Server AS WebServer;
class Server {
 public $route;
 public $params;
 public $defaultpt = 9001;
 public $defaultrt = "Index/Index/Index";
 public $defaultns = "App\\Controller\\";
 public function parseRoute() {
 if(empty($this->params['r'])) $this->params['r'] = $this->defaultrt;
 $tmpArr = explode("/",$this->params['r']??'');
 if (count($tmpArr) !=3) {
 throw new \Exception("invalid route params!");
 }
 
 array_walk($tmpArr ,function(&$itm) {
 $itm = ucfirst($itm);
 });
 $this->route = [
 'module' => $tmpArr[0],
 'controller' => $tmpArr[1],
 'method' => $tmpArr[2]
 ];
 //去掉特殊路由参数
 unset($this->params['r']);
 
 }
 //auto_laod class
 public function dispath() {
 
 $basePath = CONTROL_PATH."Base.php";
 $scriptPath = CONTROL_PATH. sprintf("%s%s%sController",$this->route['module'],DIRECTORY_SEPARATOR,$this->route['controller']).".php";
 foreach([$basePath,$scriptPath] as $r) {
 if (!file_exists($r)) {
 throw new \Exception("file {$r} is not exist!");
 }
 require_once $r;
 }
 }
 public function getInstance(){
 $className = sprintf("%s%s\\%sController",$this->defaultns,$this->route['module'],$this->route['controller']);
 $actionName = sprintf("%sAction",$this->route['method']);
 if (!class_exists($className)) {
 throw new \Exception("class name:".$className." is not exist!!");
 }
 if (!method_exists($className,$actionName)) {
 throw new \Exception("method name:".$actionName." is not exist!");
 }
 if(!Context::has($className)){
 $instance = new $className();
 Context::set($instance);
 } else{
 $instance = Context::get($className);
 }
 $instance->setParams(array_merge($this->params,$this->route));
 $res = $instance->{$actionName}();
 return $res;
 }
 
 public function start() {
 $http = new WebServer("0.0.0.0", $this->defaultpt);
 $http->on('request', function ($request, $response) {
 try{
 $this->params = array_merge($request->get??[],$request->post??[]);
 $this->parseRoute();
 $this->dispath();
 $resData = $this->getInstance();
 $response->header("Content-Type", "application/json; charset=utf-8");
 }catch(\Throwable $e) {
 $response->header("Content-Type", "text/html; charset=utf-8");
 $resData = $e->getMessage();
 }
 $response->end($resData);
 });
 
 $http->start();
 }
}
class Context{
 public static $map;
 public static function set($instance) {
 $className = get_class($instance);
 if(!self::has($className)){
 self::$map[$className] = $instance;
 }
 }
 public static function has($className) {
 return !empty(self::$map) && array_key_exists($className,self::$map);
 }
 public static function get($className) {
 if (self::has($className)) {
 return self::$map[$className];
 }
 return null;
 }
}
$sv = new Server();
$sv->start();

php index.php

curl -XGET http://127.0.0.1:9001/?r=user/index/index&uid=1

4、项目部署

4.1 本地部署

4.1.1 php安装:

4.1.2 Mongo扩展安装:

wget http://pecl.php.net/get/mongodb-1.6.0.tgz
cd /mongodb-1.6.0
phpize
./configure
 make && make install

4.1.3 Swoole扩展安装:

wget http://pecl.php.net/get/swoole-4.5.0.tgz
cd /swoole-4.5.0
phpize
./configure
 make && make install

4.1.4 Redis扩展安装:

wget http://pecl.php.net/get/redis-2.0.0.tgz
cd /redis-2.0.0
phpize
./configure
 make && make install

4.1.5 Composer依赖安装:

curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer

sudo composer install

4.1.6 开启项目

php console.php r=mysql/testMysql uid=1

php index.php #开启http服务

4.2 docker打包部署

4.2.1 构建镜像:

sudo docker build -t php-console:v2 .

4.2.2 开启容器:

sudo docker run --name php-console-v2 -p 9001:9001 -v /disks/F/php-console-v2:/opt/www:rw --restart=always -d php-console:v2

4.2.3 自动任务执行:

sudo docker exec -it php-console-v2 /bin/bash
php console.php r=mysql/testMysql uid=1

4.2.4 查看容器日志:

sudo docker logs -f --tail 100 php-console-v2

4.2.5 更新代码:

sudo docker restart php-console-v2

4.3 使用docker-compose部署

4.3.1 安装docker-compose

#下载可执行文件
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
#设置可执行权限
sudo chmod +x /usr/local/bin/docker-compose
#设置快捷方式
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
#查看版本
docker-compose --version

4.3.2 编写修改docker-compose.yml文件

version: '3'
services:
 php-console-v2:
 container_name: php-console-v2
 image: php-console:v2
 build:
 context: .
 dockerfile: Dockerfile
 volumes:
 - ./:/opt/www:rw
 ports:
 - 9001:9001
 restart: always 
 environment:
 - APP_ENV=dev
 - SCAN_CACHEABLE=false
networks:
 default:
 name: php-console-v2

4.3.3 编译容器

sudo docker-compose build

4.3.4 启动容器

sudo docker-compose up -d

4.3.5 验证容器是否正常启动

sudo docker exec -it php-console-v2 /bin/bash
cd /opt/www && compose install

5、关于其他

5.1 代码下载

5.2 命名规范

5.3 注意事项