Add files via upload

Author: Watish

README.md

@@ -1,2 +1,223 @@
-# BreadNote
-BreadNote是一款在线轻量笔记编辑平台，在浏览器访问即可使用不需要本地安装，方便快捷。
+# API development skeleton
+
+帮助你快速搭建 API 项目骨架，并指导你如何使用该骨架的细节，骨架默认开启了 SQL、Redis 日志，压测前请先关闭 `.env` 的 `APP_DEBUG`
+
+## 安装
+
+> 需要先安装 [Swoole](https://wiki.swoole.com/#/environment) 或者 [WorkerMan](http://doc.workerman.net/install/requirement.html)
+
+```
+composer create-project --prefer-dist mix/api-skeleton api
+```
+
+## 快速开始
+
+启动 [cli-server](https://www.php.net/manual/zh/features.commandline.webserver.php) 开发服务 (零依赖)
+
+```
+composer run-script --timeout=0 cliserver:start
+```
+
+启动 Swoole 多进程服务
+
+```
+composer run-script --timeout=0 swoole:start
+```
+
+启动 Swoole 协程服务
+
+```
+composer run-script --timeout=0 swooleco:start
+```
+
+启动 WorkerMan 多进程服务
+
+```
+composer run-script --timeout=0 workerman:start
+```
+
+## 执行脚本
+
+- `composer run-script` 命令中的 `--timeout=0` 参数是防止 composer [执行超时](https://getcomposer.org/doc/06-config.md#process-timeout)
+- `composer.json` 定义了命令执行脚本，对应上面的执行命令
+
+```json
+"scripts": {
+    "cliserver:start": "php -S localhost:8000 public/index.php",
+    "swoole:start": "php bin/swoole.php",
+    "swooleco:start": "php bin/swooleco.php",
+    "workerman:start": "php bin/workerman.php start",
+    "cli:clearcache": "php bin/cli.php clearcache"
+}
+```
+
+当然也可以直接下面这样启动，效果是一样的，但是 `scripts` 能帮你记录到底有哪些可用的命令，同时在IDE中调试更加方便。
+
+```
+php bin/swoole.php start
+```
+
+## 编写一个 API 接口
+
+首先修改根目录 `.env` 文件的数据库信息
+
+然后在 `routes/index.php` 定义一个新的路由
+
+```php
+$vega->handle('/users/{id}', [new Users(), 'index'])->methods('GET');
+```
+
+路由里使用了 `Users` 控制器，我们需要创建他
+
+- 如何配置路由：[mix/vega](https://github.com/mix-php/vega#readme)
+- 如何调用数据库：[mix/database](https://github.com/mix-php/database#readme)
+
+```php
+<?php
+
+namespace App\Controller;
+
+use App\Container\DB;
+use Mix\Vega\Context;
+
+class Users
+{
+
+    /**
+     * @param Context $ctx
+     * @throws \Exception
+     */
+    public function index(Context $ctx)
+    {
+        $row = DB::instance()->table('users')->where('id = ?', $ctx->param('id'))->first();
+        if (!$row) {
+            throw new \Exception('User not found');
+        }
+        $ctx->JSON(200, [
+            'code' => 0,
+            'message' => 'ok',
+            'data' => $row
+        ]);
+    }
+
+}
+```
+
+重新启动服务器后方可测试新开发的接口
+
+> 实际开发中使用 PhpStorm 的 Run 功能，只需要点击一下重启按钮即可
+
+```
+// 查找进程 PID
+ps -ef | grep swoole
+
+// 通过 PID 停止进程
+kill PID
+
+// 重新启动进程
+composer run-script swoole:start
+
+// curl 测试
+curl http://127.0.0.1:9501/users/1
+```
+
+## 使用容器中的对象
+
+容器采用了一个简单的单例模式，你可以修改为更加适合自己的方式。
+
+- 数据库：[mix/database](https://github.com/mix-php/database#readme)
+
+```
+DB::instance()
+```
+
+- Redis：[mix/redis](https://github.com/mix-php/redis#readme)
+
+```
+RDS::instance()
+```
+
+- 日志：[monolog/monolog](https://seldaek.github.io/monolog/doc/01-usage.html)
+
+```
+Logger::instance()
+```
+
+- 配置：[hassankhan/config](https://github.com/hassankhan/config#getting-values)
+
+```
+Config::instance()
+```
+
+## 部署
+
+- CLI
+
+线上部署启动时，修改 `shell/server.sh` 脚本中的绝对路径和参数
+
+```
+php=/usr/local/bin/php
+file=/project/bin/swoole.php
+cmd=start
+numprocs=1
+```
+
+启动管理
+
+```
+sh shell/server.sh start
+sh shell/server.sh stop
+sh shell/server.sh restart
+```
+
+使用 `nginx` 或者 `SLB` 代理到服务器端口即可
+
+```
+server {
+    server_name www.domain.com;
+    listen 80;
+
+    location / {
+        proxy_http_version 1.1;
+        proxy_set_header Connection "keep-alive";
+        proxy_set_header Host $http_host;
+        proxy_set_header Scheme $scheme;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        if (!-f $request_filename) {
+             proxy_pass http://127.0.0.1:9501;
+        }
+    }
+}
+```
+
+- PHP-FPM
+
+和 Laravel、ThinkPHP 部署方法完全一致，将 `public/index.php` 在 `nginx` 配置 `rewrite` 重写即可
+
+```
+server {
+    server_name www.domain.com;
+    listen 80;
+    root /data/project/public;
+    index index.html index.php;
+
+    location / {
+        if (!-e $request_filename) {
+            rewrite ^/(.*)$ /index.php/$1 last;
+        }
+    }
+
+    location ~ ^(.+\.php)(.*)$ {
+        fastcgi_pass 127.0.0.1:9000;
+        fastcgi_split_path_info ^(.+\.php)(.*)$;
+        fastcgi_param PATH_INFO $fastcgi_path_info;
+        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+        include fastcgi_params;
+    }
+}
+```
+
+## License
+
+Apache License Version 2.0, http://www.apache.org/licenses/

bin/cli.php

@@ -0,0 +1,32 @@
+#!/usr/bin/env php
+<?php
+ini_set('display_errors', 'on');
+ini_set('display_startup_errors', 'on');
+ini_set('error_reporting', E_ALL ^ E_NOTICE);
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use App\Error;
+use Dotenv\Dotenv;
+use Mix\Cli\Cli;
+
+Dotenv::createUnsafeImmutable(__DIR__ . '/../', '.env')->load();
+define("APP_DEBUG", env('APP_DEBUG'));
+
+Error::register();
+
+Cli::setName('app')->setVersion('0.0.0-alpha');
+$cmds = [
+    new Mix\Cli\Command([
+        'name' => 'clearcache',
+        'short' => 'Clear cache',
+        'options' => [
+            new Mix\Cli\Option([
+                'names' => ['k', 'key'],
+                'usage' => 'Key name'
+            ]),
+        ],
+        'run' => new App\Command\ClearCache(),
+    ])
+];
+Cli::addCommand(...$cmds)->run();

bin/swoole.php

@@ -0,0 +1,62 @@
+#!/usr/bin/env php
+<?php
+ini_set('display_errors', 'on');
+ini_set('display_startup_errors', 'on');
+ini_set('error_reporting', E_ALL ^ E_NOTICE);
+ini_set('memory_limit', '1G');
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use App\Error;
+use App\Container\Logger;
+use App\Vega;
+use Dotenv\Dotenv;
+use Mix\Init\StaticInit;
+
+Dotenv::createUnsafeImmutable(__DIR__ . '/../', '.env')->load();
+define("APP_DEBUG", env('APP_DEBUG'));
+
+Error::register();
+
+/**
+ * 多进程默认开启了协程
+ * 关闭协程只需关闭 `enable_coroutine` 配置并注释数据库的 `::enableCoroutine()` 即可退化为多进程同步模式
+ */
+
+$vega = Vega::new();
+$host = '0.0.0.0';
+$port = 9501;
+$http = new Swoole\Http\Server($host, $port);
+$http->on('Request', $vega->handler());
+$http->on('WorkerStart', function ($server, $workerId) {
+    // swoole 协程不支持 set_exception_handler 需要手动捕获异常
+    try {
+        StaticInit::finder(__DIR__ . '/../src/Container')->exec('init');
+        App\Container\DB::enableCoroutine();
+        App\Container\RDS::enableCoroutine();
+    } catch (\Throwable $ex) {
+        Error::handle($ex);
+    }
+});
+$http->set([
+    'enable_coroutine' => true,
+    'worker_num' => 4,
+]);
+
+echo <<<EOL
+                              ____
+ ______ ___ _____ ___   _____  / /_ _____
+  / __ `__ \/ /\ \/ /__ / __ \/ __ \/ __ \
+ / / / / / / / /\ \/ _ / /_/ / / / / /_/ /
+/_/ /_/ /_/_/ /_/\_\  / .___/_/ /_/ .___/
+                     /_/         /_/
+
+
+EOL;
+printf("System    Name:       %s\n", strtolower(PHP_OS));
+printf("PHP       Version:    %s\n", PHP_VERSION);
+printf("Swoole    Version:    %s\n", swoole_version());
+printf("Listen    Addr:       http://%s:%d\n", $host, $port);
+Logger::instance()->info('Start swoole server');
+
+$http->start();

bin/swooleco.php

@@ -0,0 +1,57 @@
+#!/usr/bin/env php
+<?php
+ini_set('display_errors', 'on');
+ini_set('display_startup_errors', 'on');
+ini_set('error_reporting', E_ALL ^ E_NOTICE);
+ini_set('memory_limit', '1G');
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use App\Error;
+use App\Container\Logger;
+use App\Vega;
+use Dotenv\Dotenv;
+use Mix\Init\StaticInit;
+
+Dotenv::createUnsafeImmutable(__DIR__ . '/../', '.env')->load();
+define("APP_DEBUG", env('APP_DEBUG'));
+
+Error::register();
+
+Swoole\Coroutine\run(function () {
+    StaticInit::finder(__DIR__ . '/../src/Container')->exec('init');
+    App\Container\DB::enableCoroutine();
+    App\Container\RDS::enableCoroutine();
+
+    $vega = Vega::new();
+    $host = '0.0.0.0';
+    $port = 9502;
+    $server = new Swoole\Coroutine\Http\Server($host, $port, false, false);
+    $server->handle('/', $vega->handler());
+
+    foreach ([SIGHUP, SIGINT, SIGTERM] as $signal) {
+        Swoole\Process::signal($signal, function () use ($server) {
+            Logger::instance()->info('Shutdown swoole coroutine server');
+            $server->shutdown();
+            App\Container\Shutdown::trigger();
+        });
+    }
+
+    echo <<<EOL
+                              ____
+ ______ ___ _____ ___   _____  / /_ _____
+  / __ `__ \/ /\ \/ /__ / __ \/ __ \/ __ \
+ / / / / / / / /\ \/ _ / /_/ / / / / /_/ /
+/_/ /_/ /_/_/ /_/\_\  / .___/_/ /_/ .___/
+                     /_/         /_/
+
+
+EOL;
+    printf("System    Name:       %s\n", strtolower(PHP_OS));
+    printf("PHP       Version:    %s\n", PHP_VERSION);
+    printf("Swoole    Version:    %s\n", swoole_version());
+    printf("Listen    Addr:       http://%s:%d\n", $host, $port);
+    Logger::instance()->info('Start swoole coroutine server');
+
+    $server->start();
+});