KanaPHP
关于
KanaPHP是一个轻量级快速开发框架。框架提供了一致的API接口,使得使用接口尽可能流畅;由于框架本身不依赖其他库,这使得框架本身运行速度非常快;框架希望使用最简单的方式make thing done,减少开发者的开发成本。
安装
0.环境要求
- PHP >= 5.4.0
- PDO扩展
- OpenSSL扩展
- MbString扩展
1.安装
下载release包安装
打开下面其中一个release包下载页面,选择最新release包下载:
https://github.com/kanaphp/kanaphp-release/releases
https://coding.net/u/eccozhou/p/kanaphp/git/tags
解压zip包,进入项目根目录(下文未特殊注明,目录起始位置均为此根目录)
cd kanaphp-xxx #进入项目根目录
2.配置
建立app.ini配置文件
按如下操作复制app.ini.example来新建app.ini,然后编辑app.ini以适配当前环境;
cd config
cp app.ini.example app.ini
修改runtime文件夹权限
chmod -R 777 runtime/
3.运行
使用PHP内置Server启动App
cd public
php -S localhost:9090
4.验证
在浏览器打开http://localhost:9090
验证页面是否出现用户注册表单页面,点击表单提交是否出现错误信息显示;如均能显示则表示安装成功。
目录结构
app # App命名空间目录
Console # 包含命令行Action
Blog/DailyUpdate.php # ./kana blog:dailyUpdate
Exception # 包含用户自定义异常
Http # 包含Http Action
Home/Index.php # http://localhost/home/index
Middleware # 中间件文件夹
Model # 存放业务Model
view # 包含普通视图和布局视图
bootstrap # bootstrap
app.php # app.php
config # 包含应用配置信息
app.ini # 配置映射文件
app.php # app配置文件
database.php # 数据库配置文件
middleware.php # 中间件配置文件
redis.php # Redis配置文件
route.php # 路由配置文件
session.php # Session配置文件
public # 应用web root, 包含公开访问的内容
index.php # 应用http入口
runtime # runtime目录,包含程序运行期间生成的文件
compiled # 编译文件目录
log # 日志目录
session # 文件session目录
vendor # composer vender
代码生成工具
为了减少新建类时代码复制等重复工作,KanaPHP使用命令行简化创建Model、中间件、Action的工作;
# 创建User Model
./kana make:model User
# 创建CheckToken中间件
./kana make:middleware CheckToken
# 创建接口为order/info的HTTP接口
./kana make:http order/info
# 创建order:dailyUpdate定时任务
./kana make:console order:dailyUpdate
接口预览
虽然KanaPHP将命名空间尽量简化,使用一个类时还是需要知道类位于哪个命名空间。因此引入应用component,将常用功能封装成一个个的组件,然后通过app()
作为入口访问,常用组件及API如下:
# log
app()->log->info('some thing hanppen', $extraInfo);
app()->log->notice();
app()->log->warning();
app()->log->error();
app()->log->data('event_name', $data); # 业务日志打点
# cookie
app()->cookie->set(); # 默认加密,防止客户端修改
app()->cookie->get();
# session
app()->session->set();
app()->session->get();
# 数据库
app()->db->table('user')->where('id', 1)->first();
app()->db->table('order')->where('type', '=' 1)->all();
# 加密
app()->encrypter->encrypt($data);
app()->encrypter->decrypt($data);
# Redis
app()->redis->set();
app()->redis->get();
# 验证
$post = $request->post();
$rules = [
'title' => 'required|string|between:5,50|name:标题',
'content' => 'required|string|name:内容',
'mobile' => 'required|mobile|name:手机号码',
'email' => 'required|email|name:邮箱地址',
];
app()->validator->validate($post, $rules);
文档
详细文档编写中
贡献
https://github.com/kanaphp/kanaphp
https://github.com/kanaphp/framework