Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/limingxinleo/swoft-project
基于Swoft的项目结构
https://github.com/limingxinleo/swoft-project
php project swoft swoole
Last synced: 3 months ago
JSON representation
基于Swoft的项目结构
- Host: GitHub
- URL: https://github.com/limingxinleo/swoft-project
- Owner: limingxinleo
- License: apache-2.0
- Created: 2018-06-25T12:01:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-17T01:33:26.000Z (about 6 years ago)
- Last Synced: 2024-05-17T03:44:01.051Z (8 months ago)
- Topics: php, project, swoft, swoole
- Language: PHP
- Size: 150 KB
- Stars: 16
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/swoft-cloud/swoft/releases)
[](https://travis-ci.org/swoft-cloud/swoft)
[](https://travis-ci.org/limingxinleo/swoft-project-test)
[](https://secure.php.net/)
[](https://github.com/swoole/swoole-src)
[](https://github.com/redis/hiredis)
[](https://doc.swoft.org)
[](https://github.com/swoft-cloud/swoft/blob/master/LICENSE)
# 简介
首个基于 Swoole 原生协程的新时代 PHP 高性能协程全栈组件化框架，内置协程网络服务器及常用的协程客户端，常驻内存，不依赖传统的 PHP-FPM，全异步非阻塞 IO 实现，以类似于同步客户端的写法实现异步客户端的使用，没有复杂的异步回调，没有繁琐的 yield，有类似 Go 语言的协程、灵活的注解、强大的全局依赖注入容器、完善的服务治理、灵活强大的 AOP、标准的 PSR 规范实现等等，可以用于构建高性能的Web系统、API、中间件、基础服务等等。
- 基于 Swoole 扩展
- 内置协程 HTTP, TCP, WebSocket 网络服务器
- 强大的 AOP (面向切面编程)
- 灵活完善的注解功能
- 全局的依赖注入容器
- 基于 PSR-7 的 HTTP 消息实现
- 基于 PSR-14 的事件管理器
- 基于 PSR-15 的中间件
- 基于 PSR-16 的缓存设计
- 可扩展的高性能 RPC
- 完善的服务治理，熔断，降级，负载，注册与发现
- 数据库 ORM
- 通用连接池
- 协程 Mysql, Redis, RPC, HTTP 客户端
- 协程和同步阻塞客户端无缝自动切换
- 协程、异步任务投递
- 自定义用户进程
- RESTful 支持
- 国际化(i18n)支持
- 高性能路由
- 快速灵活的参数验证器
- 别名机制
- 强大的日志系统
- 跨平台热更新自动 Reload
# 文档
[**中文文档**](https://doc.swoft.org)
QQ 交流群: 548173319
# 环境要求
1. PHP 7.0 +
2. [Swoole 2.1.1](https://github.com/swoole/swoole-src/releases) +, 需开启协程和异步Redis
3. [Hiredis](https://github.com/redis/hiredis/releases)
4. [Composer](https://getcomposer.org/)
# 安装
## 手动安装
* Clone 项目
* 安装依赖 `composer install`
## Composer 安装
* `composer create-project swoft/swoft swoft`
## Docker 安装
* `docker run -p 80:80 swoft/swoft`
## Docker-Compose 安装
* `cd swoft`
* `docker-compose up`
# 配置
若在执行 `composer install` 的时候由程序自动复制环境变量配置文件失败，则可手动复制项目根目录的 `.env.example` 并命名为 `.env`，注意在执行 `composer update` 时并不会触发相关的复制操作
```
# Server
PFILE=/tmp/swoft.pid
PNAME=php-swoft
TCPABLE=true
CRONABLE=false
AUTO_RELOAD=true
# HTTP
HTTP_HOST=0.0.0.0
HTTP_PORT=80
# WebSocket
WS_ENABLE_HTTP=true
# TCP
TCP_HOST=0.0.0.0
TCP_PORT=8099
TCP_PACKAGE_MAX_LENGTH=2048
TCP_OPEN_EOF_CHECK=false
# Crontab
CRONTAB_TASK_COUNT=1024
CRONTAB_TASK_QUEUE=2048
# Settings
WORKER_NUM=1
MAX_REQUEST=10000
DAEMONIZE=0
DISPATCH_MODE=2
LOG_FILE=@runtime/swoole.log
TASK_WORKER_NUM=1
```
## 管理
### 帮助命令
```text
[root@swoft]# php bin/swoft -h
____ __ _
/ ___|_ _____ / _| |_
\___ \ \ /\ / / _ \| |_| __|
___) \ V V / (_) | _| |_
|____/ \_/\_/ \___/|_| \__|
Usage:
php bin/swoft {command} [arguments ...] [options ...]
Commands:
entity The group command list of database entity
gen Generate some common application template classes
rpc The group command list of rpc server
server The group command list of http-server
ws There some commands for manage the webSocket server
Options:
-v, --version show version
-h, --help show help
```
## HTTP Server启动
> 是否同时启动RPC服务器取决于.env文件配置
```bash
// 启动服务，根据 .env 配置决定是否是守护进程
php bin/swoft start
// 守护进程启动，覆盖 .env 守护进程(DAEMONIZE)的配置
php bin/swoft start -d
// 重启
php bin/swoft restart
// 重新加载
php bin/swoft reload
// 关闭服务
php bin/swoft stop
```
### WebSocket Server启动
启动WebSocket服务器,可选是否同时支持http处理
```bash
// 启动服务，根据 .env 配置决定是否是守护进程
php bin/swoft ws:start
// 守护进程启动，覆盖 .env 守护进程(DAEMONIZE)的配置
php bin/swoft ws:start -d
// 重启
php bin/swoft ws:restart
// 重新加载
php bin/swoft ws:reload
// 关闭服务
php bin/swoft ws:stop
```
## RPC Server启动
> 启动独立的RPC服务器
```bash
// 启动服务，根据 .env 配置决定是否是守护进程
php bin/swoft rpc:start
// 守护进程启动，覆盖 .env 守护进程(DAEMONIZE)的配置
php bin/swoft rpc:start -d
// 重启
php bin/swoft rpc:restart
// 重新加载
php bin/swoft rpc:reload
// 关闭服务
php bin/swoft rpc:stop
```
# 更新日志
[更新日志](changelog.md)
# 协议
Swoft 的开源协议为 Apache-2.0，详情参见[LICENSE](LICENSE)