Group: 轻量级框架，整合了国内外一些不错的组件。支持redis扩展，swoole扩展的使用，实现了异步定时任务功能，异步分布式任务队列，命令行控制台，数据库脚本自动化，单元测试等等实用的功能！！还有很多不足和需要优化重构的地方，欢迎加入！https://github.com/fucongcong/framework 点击fork!

# Group

[![Code Climate](https://codeclimate.com/repos/5657fbc8ea0d1f5571028f67/badges/c8175ffa03bd301eb7c7/gpa.svg)](https://codeclimate.com/repos/5657fbc8ea0d1f5571028f67/feed)
[![Build Status](https://travis-ci.org/fucongcong/Group.svg?branch=master)](https://travis-ci.org/fucongcong/Group)

#####version 1.2.3 合并swoole http server,优化cron，上线基本的async服务
#####version 1.2.2 定时服务多进程化了。优化了异步任务队列命令提示
#####version 1.2.1 支持了异步任务队列服务，轻松搞定高并发
#####[使用swoole http server性能测试报告](https://github.com/fucongcong/ssos/blob/master/php/group%E6%A1%86%E6%9E%B6%E6%B5%8B%E8%AF%95.md)

#####未来版本开发计划： 
- 更轻量级化数据层与服务层
- rpc服务
- i18n支持
- 一些常用类库的丰富（中文转拼音，验证码，校验，过滤xss，tag...）

轻量级框架，通俗易懂，快速上手。
觉得帮到您了点击右上star!给我一点动力！
PHP交流ＱＱ群：390536187

####1.[Group框架简介](#user-content-group框架简介)

- [后端框架介绍](#user-content-框架介绍)

####2.[快速开始](#user-content-快速开始)
- [服务器配置文件](#user-content-1服务器配置文件)
- [进入框架](#user-content-2进入框架)
- [目录结构](#user-content-3目录结构)

####3.[路由篇](#user-content-路由篇)

####4.[控制层](#user-content-控制层)

####5.[服务层](#user-content-服务层)

####6.[数据层](#user-content-数据层)

####7.[视图层](#user-content-视图层)

####8.[框架基础服务](#user-content-框架基础服务)
- [Async](#user-content-async)
- [Container](#user-content-container)
- [Cache](#user-content-cache)
- [Config](#user-content-config)
- [Console](#user-content-console)
- [CronJob](#user-content-cronjob)
- [Exception](#user-content-exception)
- [EventDispatcher](#user-content-eventdispatcher)
- [FileCache](#user-content-filecache)
- [Filesystem](#user-content-filesystem)
- [Route](#user-content-route)
- [Request](#user-content-request)
- [Response](#user-content-response)
- [Session](#user-content-session)
- [Log](#user-content-log)
- [Queue](#user-content-queue)
- [Test](#user-content-test)

####9.[单元测试](#user-content-单元测试)

## Group框架简介

####环境依赖
- PHP > 5.5
- Redis
- Mysql
- Nginx or Apache
- Composer

####扩展模块
- [PhpRedis](https://github.com/phpredis/phpredis)
- [Swoole，建议最新版本，1.8.0以上](https://github.com/swoole/swoole-src)
- [beanstalkd](https://github.com/kr/beanstalkd)

####框架介绍
（1）模版引擎：twig （symfony2使用的模版引擎）

（2）分层：Dao（模型层）,Service（服务层），Controller（控制层），View（视图层）

## 快速开始
#### 准备
进入目录，执行以下命令

git clone https://github.com/fucongcong/Group.git

cd Group

composer install

####1.服务器配置文件

[Ngnix配置](https://github.com/fucongcong/Group/blob/master/doc/ngnix_server_config.txt)

####2.进入框架

访问 http://localhost:8081 进入框架主页

####3.目录结构
- app (脚本文件)
- asset (前端文件)
- config (配置文件)
- doc (文档)
- runtime (缓存)
- src (你的网站核心代码)
    - Async (异步服务)
    - Dao （模型层）
	- Services （服务层）
	- Web
        - Command (控制台命令扩展)
	 	- Controller （控制层）
	 	- Cron （异步定时器）
        - Listeners （监听器）
        - Queue （队列任务）
        - View (视图层)
	 	- routing.php （路由配置）
- index.php(主入口)
- server.php(swoole http server 入口)

## 路由篇
（1）自定义路由

（2）动态参数绑定

（3）restful API 风格

示例：

```php
<?php
return array(

'homepage'=>[
	    	'pattern' => '/',
	    	'controller' => 'Web:Home:Default:index',
	    ],

'group'=>[
	    	'pattern' => '/group/{id}',
	    	'controller' => 'Web:Group:Group:test',
	    	'methods' => 'GET',
	    ],

'create_group'=>[
	        'pattern' => '/group/{id}',
	        'controller' => 'Web:Group:Group:index',
	        'methods' => 'POST',
	    ],

'user_group'=>[
	    	'pattern' => '/user/{id}/group/{groupId}',
	    	'controller' => 'Web:Group:Group:test',
	    	'methods' => 'GET',
	    ],
);
```

## 控制层

（1）第一个控制器

```php
	<?php
	namespace src\web\Controller\Home;

use Controller;

//请继承Controller
	class DefaultController extends Controller
	{
	    //一个action 与route对应
	    public function indexAction()
	    {
	        //渲染模版 模版的启始路径可在config的view.php配置
	        return $this -> render('Web/Views/Default/index.html.twig');
	    }

}

?>
```

（2）如何获取路由传过来的参数？详见Request与Route服务

```php
<?php
namespace src\Web\Controller\Group;

use Controller;
use Request;
//在后面我们可以跟上路由定义好的参数，$id
public function testAction(Request $request, $id)
{
    // echo $id; echo "<br>";

//可以获取整个路由地址
    $uri = $this -> route() -> getUri();
    //获取所有参数
    $parameters = $this -> route() -> getParameters();
    //获取参数名
    $parametersName = $this -> route() -> getParametersName();
    //获取当前action的名称
    $action = $this -> route() -> getAction();
    //获取系统支持的请求方法
    $methods = $this -> route() -> getMethods();

$currentMethod = $this -> route() -> getCurrentMethod();
    //获取当前时区
    $timezone = $this -> getContainer() -> getTimezone();
    //获取当前运行环境
    $environment = $this -> getContainer() -> getEnvironment();
    //这里和Service服务层交互
    echo $this->getGroupService()->getGroup(1);
    //传入模板
    return $this -> render('Web/Views/Group/index.html.twig',array(
        'uri' => $uri,
        'parameters' => $parameters,
        'parametersName' => $parametersName,
        'action' => $action,
        'methods' => $methods,
        'currentMethod' => $currentMethod,
        'timezone' => $timezone,
        'environment' => $environment
        ));
}
public function getGroupService()
{
	//创建一个Service实例
    return $this -> createService("Group:Group");
}
```

## 服务层
#####（1）简单介绍一下目录结构
- Group (示例)
    - Impl （服务层实现的接口）
    - Rely （定义服务之间的依赖关系）
GroupService.php(接口)

#####服务层主要用于处理数据层与控制层间数据的业务处理。只要继承Service类就可以了。

GroupService.php
```php
<?php
namespace src\Services\Group;

interface GroupService
{
    public function getGroup($id);
}
```

/Rely/GroupBaseService.php

```php
<?php
namespace src\Services\Group\Rely;

use Service;
//定义在Rely文件下的依赖
abstract class GroupBaseService extends Service
{
    //获取数据层的对象实例
    public function getGroupDao()
    {
        return $this->createDao("Group:Group");
    }

//获取其他服务的对象实例
    public function getUserService()
    {
        return $this -> createService("User:User");
    }
}
```

/Impl/GroupServiceImpl.php

```php
<?php
namespace src\Services\Group\Impl;

use src\Services\Group\Rely\GroupBaseService;
use src\Services\Group\GroupService;

class GroupServiceImpl extends GroupBaseService implements GroupService
{
    //实现定义的服务层接口方法
    public function getGroup($id)
    {
        return $this -> getUserService() -> getUser(1);
        //return $this->getGroupDao()->getGroup($id);
    }

}
```

## 数据层
#####支持主从配置(详见配置文件)

#####如何使用

```php
<?php

namespace src\Dao\Group\Impl;

use Dao;
    use src\Dao\Group\GroupDao;

class GroupDaoImpl extends Dao implements GroupDao
    {
        //定以数据表
        protected $tables="groups";

//具体方法
        public function getGroup($id)
        {
            $sql="SELECT * FROM {$this->tables} WHERE id=:id LIMIT 0,1";
            //动态参数绑定
            $bind = array('id' => $id);
            //读取默认配置
            //$group = $this->getDefault()->fetchOne($sql, $bind);

//读取写服务器配置，如果没有指定具体参数，随机写入分配的服务器
            //$group = $this->getWrite('master1')->fetchOne($sql, $bind);
            //$group = $this->getWrite('master2')->fetchOne($sql, $bind);

//读取读服务器配置，如果没有指定具体参数，随机读取分配的服务器
            //$group = $this->getRead()->fetchOne($sql, $bind);
            return $group ? $group : null;
        }

}
```

#####支持的语法

#####fetch(*)
```php
    $pdo = $this->getDefault();

$stm  = 'SELECT * FROM test WHERE foo = :foo AND bar = :bar';
    $bind = array('foo' => 'baz', 'bar' => 'dib');
    $result = $pdo->fetchAll($stm, $bind);

// fetchAssoc() returns an associative array of all rows where the key is the
    // first column, and the row arrays are keyed on the column names
    $result = $pdo->fetchAssoc($stm, $bind);

// fetchGroup() is like fetchAssoc() except that the values aren't wrapped in
    // arrays. Instead, single column values are returned as a single dimensional
    // array and multiple columns are returned as an array of arrays
    // Set style to PDO::FETCH_NAMED when values are an array
    // (i.e. there are more than two columns in the select)
    $result = $pdo->fetchGroup($stm, $bind, $style = PDO::FETCH_COLUMN)

// fetchObject() returns the first row as an object of your choosing; the
    // columns are mapped to object properties. an optional 4th parameter array
    // provides constructor arguments when instantiating the object.
    $result = $pdo->fetchObject($stm, $bind, 'ClassName', array('ctor_arg_1'));

// fetchObjects() returns an array of objects of your choosing; the
    // columns are mapped to object properties. an optional 4th parameter array
    // provides constructor arguments when instantiating the object.
    $result = $pdo->fetchObjects($stm, $bind, 'ClassName', array('ctor_arg_1'));

// fetchOne() returns the first row as an associative array where the keys
    // are the column names
    $result = $pdo->fetchOne($stm, $bind);

// fetchPairs() returns an associative array where each key is the first
    // column and each value is the second column
    $result = $pdo->fetchPairs($stm, $bind);

// fetchValue() returns the value of the first row in the first column
    $result = $pdo->fetchValue($stm, $bind);

// fetchAffected() returns the number of affected rows
    $stm = "UPDATE test SET incr = incr + 1 WHERE foo = :foo AND bar = :bar";
    $row_count = $pdo->fetchAffected($stm, $bind);
```
#####数组转换

```php
    $pdo = $this->getDefault();

$stm = 'SELECT * FROM test WHERE foo IN (:foo)'

$array = array('foo', 'bar', 'baz');
    $cond = 'IN (' . $pdo->quote($array) . ')';

$bind_values = array('foo' => $array);
    $sth = $pdo->perform($stm, $bind_values);
    echo $sth->queryString;
    // "SELECT * FROM test WHERE foo IN ('foo', 'bar', 'baz')"
```

## 视图层
#####基础的twig语法文档请查看twig官方(twig.sensiolabs.org/documentation)
#####简单介绍框架内部扩展好的方法

{{ asset("asset/css/bootstrap.min.css") }} asset方法主要是用于获取前端js,css文件的地址

{{ url('create_group', {'id':1}) }} 用于匹配路由,第一个参数是routing配置文件的主键，后面是参数，以数组形式

{{ render('Web:Group:Group:index') }} 在一个twig文件内部，可以render其他controller下面的模块。

{{ 1454566745|smart_time }} 时间戳转换

#####开启csrf验证防止跨站攻击

//在post 请求时，如果在session.php配置文件中开启csrf_check参数，默认会检查csrf_token参数。你可以在表单中加入以下参数
    <form method="post" action="{{url('create_group', {'id':1})}}">
    
      <input type="hidden" name="csrf_token" value="{{ csrf_token() }}">

## 框架基础服务

## Container
#####Container是一个基础的容器，一些系统变量会存放于这里

## Cache

#####目前只支持了Redis得cache，使用请在cache.php配置中配置redis

```php

use Cache;
    //key value expireTime
    Cache::set('ha', 123, 60);
    //也可以这样
    Cache::redis() -> set('haa', 123, 60);

Cache::get('ha');
    Cache::hSet($hashKey, $key, $data, $expireTime);
    Cache::hGet($hashKey, $key);
    Cache::hDel($hashKey, $key);
    Cache::hDel($hashKey);

//现在的类库方法还未扩展完全，目前只有以上方法
    //你可以使用Cache::redis() 获取redis实例，这是一个PhpRedis的实例，api－》(https://github.com/phpredis/phpredis)
```

## FileCache

#####文件形式的缓存

```php

use FileCache;

//默认路径是放在runtime/cache/
    FileCache::set('test.php', ['testdfata' => 'datadata']);
    //指定路径
    FileCache::set('test.php', ['testdfata' => 'datadata'], 'runtime/cache/test/');

FileCache::get('test.php');
    FileCache::get('test.php', 'runtime/cache/test/');

```

## Config

#####用于查找config目录下得配置

```php

use Config;

//文件名::key
    Config::get('app::environment');

//也可以重新设置ests
    Config::set('app', 'environment', 'dev');
```

## EventDispatcher

#####事件监听Listener

#####先写一个监听KernalResponseListener
```php
<?php

namespace src\web\Listeners;

use Listener;
use Event;

class KernalResponseListener extends Listener
{
    public function setMethod()
    {
        return 'onKernalResponse';
    }

//触发时执行
    public function onKernalResponse(Event $event)
    {
        echo 'this is a KernalResponse Listener';
    }
}

```

#####绑定监听

```php

use EventDispatcher;

$listener = new KernalResponseListener();

//定义一个事件名称，触发的监听器，和一个重要指数
    EventDispatcher::addListener('kernal.responese', $listener, 10);

EventDispatcher::removeListener('kernal.responese', $listener);

EventDispatcher::hasListeners('kernal.responese');

//最后可以在需要的时候派发事件
    EventDispatcher::dispatch('kernal.responese');
    EventDispatcher::dispatch('kernal.responese', $envet);

```

#####事件绑定器Subscriber

## Session

#####Session 目前支持2中方式存储，默认存放在runtime/sessions下，也可以开启redis driver，将session存在redis中，详见配置
```php

use Session;

Session::set('group', 'good');
    Session::get('group');
    Session::remove('group');
    Session::has('group');
    Session::clear();
    Session::all();
    Session::isStarted();

$attributes = ['group' => 'hello'];
    Session::replace($attributes);
```
## Log

#####默认存放于runtime/log
```php

use Log;

Log::debug('123',['user'=>1]);
    Log::info('123',['user'=>1]);
    Log::notice('123',['user'=>1]);
    Log::warning('123',['user'=>1]);
    Log::error('123',['user'=>1]);
    Log::critical('123',['user'=>1]);
    Log::alert('123',['user'=>1]);
    Log::emergency('123',['user'=>1]);

//默认model是web.app,也可以自定义
    Log::emergency('123',['user'=>1],'web.admin');

```

## Console

####控制台的使用方法

//进入根目录 执行
    app/console

----------------------------------------------------------

-----        ----      ----      |     |   / ----
        /          | /        |      |    |     |   |      |
        |          |          |      |    |     |   | ----/
        |   ----   |          |      |    |     |   |
         -----|    |            ----       ----     |

----------------------------------------------------------

使用帮助: 
     Usage: app/console [options] [args...]

generate:service name       生成一个自定义service
     generate:controller  name    生成一个自定义controller
     sql:generate                生成一个sql执行模板(存放于app/sql)
     sql:clean                清除lock文件,您可以再次执行migrate脚本中的命令
     sql:migrate   [default|write|read|all] [name]  参数可不填，执行sql模板(默认会向default服务器执行.第二个参数只有当第一个参数为write|read时，才会生效,如果不填，默认为write|read下面所有服务器)
     sql:rollback   [default|write|read|all] [name]  参数可不填，执行sql模板(默认会向default服务器执行.第二个参数只有当第一个参数为write|read时，才会生效,如果不填，默认为write|read下面所有服务器)

####自定义控制台
#####配置文件config/app.php  
```php
    //扩展console命令行控制台
    'console_commands' => [
        'log:clear' => [
            'command' => 'src\Web\Command\LogClearCommand', //执行的类
            'help' => '清除日志', //提示
        ],
    ],
```
## CronJob
#####异步定时器介绍(目前只支持秒级定时，毫秒级定时暂未修改，可以实现)
#####依赖：[Swoole1.7.14以上版本](https://github.com/swoole/swoole-src)

#####配置文件config/cron.php
```php
    return [

'cache_dir' => 'runtime/cron',

'class_cache' => 'runtime/cron/bootstrap.class.cache',

//log路径
        'log_dir' => 'runtime/cron',

//定时器轮询周期，精确到毫秒
        'tick_time' => 1000,

'job' => [

[
                'name' => 'TestLog',//任务名
                'time' => '*/1 * * * *',//定时规则 分 小时 天 周 月
                'command' => 'src\Web\Cron\Test',//执行的类库
            ],

[
                'name' => 'testCache',
                'time' => '24 */2 * * *',//定时规则 分 小时 天 周 月
                'command' => 'src\Web\Cron\TestCache',
            ],

[
                'name' => 'testSql',
                'time' => '*/2 * * * *',//定时规则 分 小时 天 周 月
                'command' => 'src\Web\Cron\TestSql',
            ],

],
    ];
```
#####执行命令

app/cron start|restart|stop

## Queue
#####异步队列服务介绍
#####依赖：[Swoole1.7.14以上版本](https://github.com/swoole/swoole-src) 
#####依赖：[beanstalkd](https://github.com/kr/beanstalkd)

#####向队列插入任务
```php

use Queue;

//队列名
    $tube = 'testjob1';
    //具体数据
    $data = '这是第一个队列任务';
    //就这么简单 队列已经被塞入内存
    //$priority, $delaytime, $lifetime 可不填。默认会取配置的参数
    $priority = 1;
    $delaytime = 0;
    $lifetime = 60;
    Queue::put($tube, $data, $priority, $delaytime, $lifetime);

```
#####配置config/queue.php  
#####开启异步队列服务处理任务
    
    app/queue start|restart|stop

#####最后看看我们的任务怎么写
```php
    <?php

namespace src\Web\Queue;

use Group\Queue\QueueJob;

class TestJob extends QueueJob
{   
    public function handle()
    {      
        //队列任务的id号
        $jobId = $this -> jobId;
        //你在插入队列时的数据
        $jobData = $this -> jobData;
        //后面就可以写处理的逻辑了
        \Log::info('queue handle job'.$this -> jobId, ['time' => date('Y-m-d H:i:s', time())], 'queue.job');
    }

}
```
#####队列图形化管理工具[beanstalk_console](https://github.com/ptrofimov/beanstalk_console) 
## 单元测试

phpunit --bootstrap app/test.php src

乐登/Group

简介

发行版

贡献者

近期动态

乐登/Group .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

乐登/Group