一个简单易用的轻量PHP框架。

Maintainers

Details

github.com/topyao/yao

Source

Issues

Installs: 36

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 0

Open Issues: 0

Type:project

0.0.6 2021-01-18 11:14 UTC

This package is auto-updated.

Last update: 2021-01-19 14:19:03 UTC


README

要求

PHP >= 7.4
PDO扩展
MBString扩展

使用composer安装:

composer create-project chengyao/yao .

这行命令会在你命令执行目录安装框架

你可以使用Git安装,安装完成后会自动启动服务

git clone https://github.com/topyao/yao.git . && php yao serve

你也可以直接在项目目录更新依赖

composer install

安装完成后就可以使用 php yao serve 运行程序。框架强制路由,所以在编写控制器前应该先定义路由规则,如果你的环境是windows需要修改public/.htaccess中的RewriteRule或者nginx伪静态规则,在index.php后面加上?。框架对数据类型比较敏感,例如在该设置为true时候不要设置1。否则会报错。

如果你安装的是开发版本,安装完成后可能需要手动删除vendor/chengyao下的包中的.git文件夹。强烈不建议使用开发版本

2.伪静态

下面提供了apachenginx的伪静态配置

apache

<IfModule mod_rewrite.c>
  Options +FollowSymlinks -Multiviews
  RewriteEngine On
  RewriteCond %{REQUEST_FILENAME} !-d
  RewriteCond %{REQUEST_FILENAME} !-f
  RewriteRule ^(.*)$ index.php/$1 [QSA,PT,L]
</IfModule>

nginx

if (!-d $request_filename){
	set $rule_0 1$rule_0;
}
if (!-f $request_filename){
	set $rule_0 2$rule_0;
}
if ($rule_0 = "21"){
	rewrite ^/(.*)$ /index.php/$1 last;
}

目录结构

  • app 应用目录
    • Http
      • Controllers 控制器目录
      • Middleware 中间件目录
      • Validate 验证器目录
      • Controller.php 基础控制器类
      • Provider.php 服务注册类
      • Validate.php 验证器类
    • Models 模型目录
    • Services 服务目录
    • Facade 用户自定义门面目录
    • common.php 用户自定义函数文件
  • config 配置文件目录
    • app.php 应用配置文件
    • database.php 数据库配置文件
    • view.php 视图配置文件
  • extend 扩展类库目录【命名空间为\】
  • public 应用访问目录
    • .htaccess apache伪静态文件
    • nginx.conf nginx伪静态文件
    • index.php 入口文件
  • routes 路由目录
    • web.php 路由文件
  • vendor 扩展包(包含框架核心)
  • views 视图目录
  • .env 环境变量文件
  • .env.example 环境变量示例文件
  • .htaccess 伪静态文件
  • composer.json composer配置文件
  • composer.lock composer锁定文件
  • LICENSE 开源许可证
  • README.md 手册
  • yao 命令行文件

框架对单/多应用这个概念比较模糊,只是在定义路由和渲染模板的时候应该有所注意,这里在下面的章节中会提到。

配置

配置文件包含两种,一种是config目录下的以小写字母开头的.php为后缀的文件,另一种是框架根目录下的.env文件,下面简单介绍下如何使用他们。

ENV

在开发环境下大多数配置都可以通过.env文件获取,而且默认为从.env文件获取,线上环境需要删除.env文件或者将配置中的env去掉,例如在app.php中有这样'debug' => env('app.debug', false),一个配置,我们可以更改为'debug' => false, .env文件可以使用节,例如:

[APP]
DEBUG=true #开启调试
AUTO_START=true 

其中app就是一节,获取DEBUG配置可以使用env('app.debug')或者\Yao\Facade\Env::get('app.debug');

config

配置文件是位于config目录下,以.php结尾的返回一个关联数组的文件。

获取所有配置使用

\Yao\Facade\Config::get();

可以传入一个参数例如app,则会获取app.php文件中的配置,传入app.auto_start 则获取app中的auto_start参数的值

如果需要自定义一个配置文件,可以在/config目录下新建例如alipay.php文件并返回一个数组。

\Yao\Facade\Config::load('alipay');         //加载配置(一次请求只需要加载一次)
\Yao\Facade\Config::get('alipay.param');	   //获取配置

可以使用辅助函数config() ,例如config('app.debug')

路由

路由可以添加在route/route.php文件中,如果需要分文件存放,可以将其他文件引入该文件或者在route目录下新建文件

注意:需要引入Yao\Facade\Route

路由定义

路由的定义方式有三种:字符串,数组,闭包

路由定义需要设置请求方式例如

Route::get('路由地址','路由表达式');   //get方式请求的路由  
Route::post('路由地址','路由表达式');  //post方式请求的路由

请求方式可以是get,post,put,delete,patch等请求类型,以下非特殊都是用get做演示,这里的路由地址是不包含queryString的,即使url中有queryString,也会匹配该路由。

字符串

当我们使用单应用模式的时候,按照下面的方法定义路由

Route::get('路由地址','控制器/方法');

例如

Route::get('index','index/index/index'); 

这里的index/index/index中最后一个斜线后的字符串为调用的方法名,前面的组成类似App\Http\Controllers\Index\Index的类名,对应到目录中为/app/Http/Controllers/index/index.php 这样就很容易理解如何创建单/多应用。只需给路由表达式添加多个斜线分割,对应于类所处的文件夹上下级。

数组

使用数组的方式定义路由,数组的第一个参数必须是一个控制器类的完整类名,第二个参数为方法名字符串,例如

Route::get('index',['\App\Http\Controllers\Index','index']);

表示映射到\App\Http\Controllers\Index控制器的index方法

闭包

Route::get('index',function(){
       return view('模板文件');
});

注意:这里使用到了view助手函数,当路由地址中含有参数时可以给闭包函数传递相应参数,在下面会提到。

路由高级

多请求类型路由

当我们一个url需要多种请求方式来访问的时候可以定义rule类型的路由,例如:(这里的/非必须,但是建议加上)

Route::rule('/', 'index/index/index', ['get', 'post']);

第三个参数传入请求方式数组,可以为空,为空默认为getpost

正则表达式与参数传递

在上面提到了路由是可以给控制器方法或者闭包传递参数的。

例如我定义了一个如下的路由

Route::get('/article/index(\d+)\.html', 'index/article/read');

该路由的第一个参数是一个不带定界符的正则表达式,该表达式会匹配/article/任意数字.html的请求地址,这个正则中使用了一个匹配组(\d+),并且这个组是第一次出现的,那么就可以在控制器方法或者闭包中传入一个参数。

给闭包传参

Route::get('/article/index(\d*)\.html',function($id = 0){
	echo $id;
});

给控制器方法传参

public function read($id = 0){
	echo $id;
}

可以传入多个参数,传入顺序按照preg_match之后的match数组去掉第一个之后的顺序传入,,例如:

Route::get('/(\w+)-index(\d+)\.html',function($a,$b){
	echo $a,$b;
});

访问blog-index2.html 时会输出blog2

注意:正则路由中的正则不需要添加定界符,多个参数是按匹配到的顺序传递的。转义符号务必使用反斜线,否则url助手函数可能不能正确获取到正则路由的地址

路由支持注册别名,例如

Route::get('/','index/index/index')->alias('index');

之后就可以在任意位置使用url助手函数获取路由地址,例如url('index') 返回'/',如果url() 函数中传入的参数并没有被注册别名,那么会原样返回。url函数可以添加第二个参数来给正则路由传递参数,例如

Route::get('/b(.*)\.html','index/index/index')->alias('blog');

此时可以使用url('blog',[1]); 生成的url地址为/b1.html ,这里url的第二个参数为一个索引数组,参数按照在数组中的顺序传递。

路由可以设置缓存

php yao route   //根据提示选择选项

设置缓存文件后路由不会再通过调用/route下文件中的大量方法来注册,而是直接从缓存文件中读取,所以在开发环境上建议不要使用路由缓存,否则新增或删除路由不能及时更新

其他规则路由

可以直接定义视图路由

Route::view('index','index/index',['get']);

该路由表示get方式请求的/index会被映射到views目录下的index目录下的index.html模板文件,分隔符后最后的部分为模板文件名,前面均为目录名。最后一个参数为可选参数,为空默认为get方式请求的路由;

可以定义重定向路由

Route::redirect('index','https://www.1kmb.com',['get'],302);

该路由表示get方式请求的/index会被重定向到https://www.1kmb.com。后两个参数为可选参数,第一个为路由请求方式,默认为get;第二个为响应状态码,默认为302;

跨域支持【开发中】

可以在定义路由的时候设置允许跨域

Route::get('/','index/index/index')->cross('*'); 

请求

获取请求参数

获取请求可以用Facade

\Yao\Facade\Request::get()

或者使用

new Request(?array $filters = null) 

可以不传参数,传入的参数必须是包含可以使用的过滤函数的数组,当独立使用时建议加上参数可以实现获取数据的过滤。

获取所有get的参数列表

\Yao\Facade\Request::get()

如果需要获取某一个参数,可以使用

\Yao\Facade\Request::get('a');

获取多个参数可以使用

\Yao\Facade\Request::get(['a','b']);

还可以获取post请求的内容

\Yao\Facade\Request::post();

获取所有$_REQUEST使用

\Yao\Facade\Request::param();

post和param使用方法和get一样。可以给这些方法添加第二个参数,第一个参数为字符串且不存在的时候会返回默认参数

获取$_SETVER 变量

替代地,可以使用Request::server($name) 获取$_SERVER中的值,如果不存在返回null

获取header

可以使用Request::header(); 获取所有header信息,可以传入一个参数,例如Request::header('user_agent');获取UA

判断请求类型

使用isMethod方法判断任何请求类型,例如判断请求类型是否为get

\Yao\Facade\Request::isMethod('get');

还可以判断是否是ajax请求

\Yao\Facade\Request::isAjax() 

参数过滤

请求是可以设置函数进行过滤的,可以在app.php中的filter数组中添加过滤函数,注意函数必须只能传入一个参数,并且返回过滤后的字符串。如果使用Request类获取参数默认是被过滤的。不需要过滤可以使用$_GET数组。

注意:如果需要获取的参数不存在,该参数的值将会是null,例如Request::get(['a','b'])当b不存在的时候会是null,此时需要用is_null判断。

响应

在控制器中可以直接return 一个数组,框架会自动转为json输出,也可以使用json() 助手函数,或者response()函数,可以使用连贯操作,例如json(array $data)->code(202)->header(['Content-Type:application/json']);

验证器

需要验证的数据必须是数组,比如通过Request类方法传入数组获取的数组。

控制器验证

public function test()
   {
       $data = Request::post();
       $vali = Yao\Facade\Validate::rule([
           'username' => ['required' => true, 'max' => 10, 'regexp' => '\w+']
       ])->check($data);
       if (true !== $vali) {
           exit($vali);
       }
   }

验证器操作必须按照如上代码写,可以在App\Validate类中添加方法例如_checkUservali,验证成功返回true,失败将消息新增到成员属性$message数组后返回false。之后使用rule方法的时候就可以使用rule(['username' => ['uservali' => 1]);验证username字段。当一个字段验证失败后就不会再验证其他字段了! 验证器支持全部验证,只需要给check方法的第二个参数传入true即可开启全部验证,非批量验证失败返回消息字符串,批量验证失败返回消息索引数组。

默认可用的验证器有max,min,length,enum,required,regexp,bool,confirm

_checkBool 当值为'on', 'yes', 'true', true, 1, '1'时为真,相反为假,在验证规则中应该传入true或者false 在验证regexp的时候需要编写完整验证正则表达式包括定界符,例如:/\d+@\w+\.\w{3}/i 注意这里验证使用了preg_match,所以在编写正则表达式的时候应该注意,例如不要使用模式修正符g

独立验证

添加了独立验证,你可以在任何可以composer自动加载的位置添加验证器类例如UserVali,并继承App\Validate,在该类中添加验证规则$rule

 protected array $rule = [
        'username' => ['required' => true]
    ];

如果你继承了基础控制器,就可以使用下面的方法进行数据验证

$res = $this->validate($data,UserVali::class)->check();

第一个参数为需要验证的数据,第二个参数为验证器类名完整字符串,注意这里追加的规则时使用+语法将两个数组合并,可能导致覆盖,独立验证可以设置属性$checkAll用来设置是否是全部验证,当$checkAll为true时开启批量验证,否则一旦有验证失败的条目都会结束验证。独立验证可以使用连贯操作和追加删除操作,例如

$vali = $this->validate($data, UserVali::class)->min(['a' => 1])->remove(['password' => ['required']])->append(['password' => ['min' => 1]])->check();

验证器随意增加或者删除验证规则,例如:

Validate::rule(['a' => ['required' => true])->append(['a' => ['max' => 2,'min' => 1]])->append(['b' => ['required' => true])->remove('a')->remove(['a' => ['required','max'])->remove(['a' => 'min'])->check($data);

验证器还可以使用连贯操作

$vali = Validate::data($data)->max(['a' => 10])->required(['a' => true,'b' => true)->check();

或者使用

(new Validate($data))->max('a',10)->check();

或者使用

(new Validate())->max('a',10)->check($data);

注意:这的Validate可以是任意你新建的继承了App\Validate或者\Yao\Validate的类,只是前者会包含你自定义的验证规则,后则会不包含,并且如果在你的验证器类中存在rule属性的设置就不再需要传入rule规则了,直接使用check即可。如果验证成功会返回true,否则返回带有错误信息的数组,使用闭包验证时func方法第一个参数传入要验证的字段,第二个参数传入闭包,第三个参数可选传入传递给闭包的参数列表数组。

验证提示

可以自定义验证规则的提示,只需要给属性notice设置和验证规则类似的数组,并且将验证的限定值改为提示信息即可。

验证器支持设置验证失败抛出异常,只需将独立验证的属性throwAble设置为true,或者给check方法传入第三个参数true,即可开启抛出异常,批量验证失败抛出异常信息为json。

控制器

假如我定义了以下路由

Route::get('/','index/index/index');

如果需要编写控制器代码,就需要编写/app/Http/Controllers/Index目录下的Index.php控制器里的index方法

控制器的基本代码如下:

<?php

namespace App\Http\Controllers\Index;

class Index
{
    public function index()
    {
    }
}

控制器可以继承\App\Http\Controller 基础控制器来使用基础控制器中提供的方法,你也可以自定义基础控制器

可以给控制器方法传入参数,参数个数和位置取决于路由中正则匹配到的参数。 当路由中的参数为可选,就应该给控制器参数一个初始值

视图

使用内置模板驱动

模板引擎可以使用twig或者smarty,可以在config/view.php中设置模板引擎。

注意:需要手动改安装对应模板引擎;

视图目录位于根项目目录下views文件夹,可以使用助手函数渲染模板

view('index/index');

这里的第一个参数和控制器解析规则类似,表示/views/index/index.html 模板文件,这里的模板后缀可以在/config/view中修改suffix 选项

模板渲染方法可以传入第二个数组参数用来给模板赋值,例如

view('index',['data'=>$data]);

或者使用Facade

\Yao\Facade\View::render('index',$params);

你可以使用composer安装你喜欢的模板引擎

自定义驱动

框架允许你自定义任何视图驱动,可以在任何可以composer自动加载的位置定义视图驱动,并且在视图配置view.php中将type和视图配置名改为你的视图驱动完整类名。

视图驱动需要继承\Yao\View\Driver.php 并且实现public function render($params){}方法。继承该类后可以使用$this->templateDir 获取模板路径(例如/views),使用$this->template 获取需要渲染的模板文件名。使用方法可以参考内置的视图驱动。

Facade(类静态代理)

facade基本代码示例如下:

<?php

namespace App\Index\facade;

use Yao\Facade;

class UserCheck extends Facade
{
    protected static function getFacadeClass()
    {
        return \App\Index\validate\UserCheck::class;
    }

}

你可以在任何可以composer自动加载的位置创建独立验证器类并继承Yao\Facade类,就可以实现静态代理,但是为了方便维护,建议创建在应用对应的facade目录下。

注意: Facade默认实例化对象都不是单例的。如果需要使用单例,可以加入protected static $singleInstance = true;,当然仅仅是在你的请求的页面中使用该类的方法全部为facade的时候才是单例的。

数据库

支持mysql,pgsql

很遗憾,由于本人技术有限,目前的Db类只对mysql支持良好,其他数据库暂时没有测试。如果有需求可以使用composer安装第三方的数据库操作类,例如:medoothinkorm

新增

db('users')->insert(['name' => 'username','age' => 28]);

删除

db('users')->where(['id' => 1])->delete();

查询

\Yao\Facade\Db::name('表名')->field('字段')->where(['条件'])->limit(1,3)->find()/select();

查询到的是数据集对象,可以使用toArray或者toJson获取,例如

\Yao\Facade\Db::name('users')->limit(1)->select()->toArray();

可以使用value($fiels); 获取某一个字段的值

更新

db('users')->where('id > 10')->update(['name' => 'zhangsan']);

其中field默认为*where可以传入字符串或者一维数组,find查询一条,select查询所有。limit可以传入1到2个参数,对应mysqllimit。目前只对where条件做了预处理

例如我可以写如下语句

\Yao\Facade\Db::name('users')->field('username')->where(['age' => 19])->limit(1,2)->select();

表示我要查询users表中年龄为19的用户名,并且取出偏移量为2,限制条数为1的用户名。 当然可以使用\yao\Facade\Db::name('users')->select() 查询全部 可以使用助手函数例如:db($tableName)->select();

添加whereLike(array $array) 需要传入一个数组,数组的键为字段名,数组的值为模糊匹配值,例如%name%

whereLike(['a' => '%time%','b' => '%b%'])

添加whereIn(array $array) 需要传入一个数组,数组的键为字段名,数组的值范围数组,例如

whereIn(['a' => ['1','4'],'b' => ['c','d'])

当然我们更方便地使用execquery两个方法来操作数据库,一般query是对应于查询,exec用来增加删改。使用方法如下: Db::exec($sql,$data),其中sql可以是预处理语句,需要绑定的数据传入data,可以使用?占位符和:占位符,返回值为前一条语句影响的条数 Db::query($sql,$data,$all) 前两个参数和exec是一致的,第三个参数为true时查询出全部数据(默认),为false时查询出单条数据。 例如

Db::query('SELECT * from users where id > :id',['id' => 1],true);

表示查询出所有id大于1的用户信息

Db::exec('UPDATE users SET name=? where id = ?',['zhangsan',1]);

修改id为1的用户的名字为张三

删除

\Yao\Facade\Db::name('users')->where('id > 10')->delete();

删除id大于10的用户。

注意:你可以自行安装medoothink-orm等数据库操作类库或者使用自带的Db类,该Db类的操作方法大部分需要的是数组类型的参数。

服务

服务实现基本代码如下

<?php

namespace App\Index\Services;

class Serve implements
{
	public function register(){}
    public function boot()
    {
        echo '1';
    }
}

容器

可以使用容器创建类并调用类的方法

Container::instance()->get('类名',array $arguments)->invoke(’调用方法名‘,'给方法传递的参数');

命令操作

框架提供了不丰富的命令操作,目前支持路由列表,路由缓存,启动内置服务等操作;只需要在项目目录下打开命令窗口输入以下指令就可以方便地进行各种操作。

php yao        //所有命令的帮助
php yao serve  //会提示输入一个端口来创建服务,默认为8080
php yao route  //会提示输出列表或者路由缓存操作,根据提示输入数字即可

如果你的项目根目录没有yao 文件,则需要在git上下载相应框架版本的yao文件

联系邮箱:bigyao@139.com,感谢:https://www.jetbrains.com/?from=topyao