PHPackages                             ahas/sentinel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. ahas/sentinel

ActiveLibrary[Authentication & Authorization](/categories/authentication)

ahas/sentinel
=============

sentinel php client (use sidecar).

v0.1.1(5y ago)141.7k↓60%Apache-2.0PHP ^5.5 || ^7.0

Since May 29Compare

[ Source](https://github.com/sentinel-group/sentinel-php-client)[ Packagist](https://packagist.org/packages/ahas/sentinel)[ RSS](/packages/ahas-sentinel/feed)WikiDiscussions Synced today

READMEChangelogDependencies (1)Versions (3)Used By (0)

Sentinel PHP Client
===================

[](#sentinel-php-client)

快速体验
----

[](#快速体验)

如果您是第一次接触 Sentinel，可通过 sentinel-php-demo 快速体验 Sentinel 流量防护能力。 Linux 下可使用 docker 启动 demo ，启动命令如下 (选项 `--net=host` 表示容器使用宿主机网络)：

```
docker run --name=demo --net=host -d registry.cn-hangzhou.aliyuncs.com/ahas/sentinel-php-demo demo/bin/demo.sh --local
```

> 使用结束后，使用如下命令删除 demo 容器：
>
> ```
> docker rm demo -f
> ```

demo 容器内包含：

- php + nginx 环境，nginx 默认监听 8080 端口。
- sentinel sidecar 进程，默认监听 9090 端口。
- php demo 测试代码。

demo 启动后，可通过  访问 demo 测试页面。 demo 中默认定义了一个名为 `hello` 的资源，保护该资源每秒钟最多只允许被访问 3 次。 页面 `/hello.php` 使用了该资源，每秒请求压力超过 3 次时，将提示超过压力的请求稍后再试。 demo 主页是一个简单的测试页面，快速连续点击 **请求** 按钮向 `/hello.php` 页面发起请求，可看到类似如下的输出结果。

[![demo](doc/image/demo.png)](doc/image/demo.png)

在 PHP 中使用 Sentinel
------------------

[](#在-php-中使用-sentinel)

准备在您的 PHP 项目中试用 Sentinel，棒！ 首先梳理需要保护的资源，如数据库访问或后端 RPC 接口等，为资源取一个简单清晰的名字。 这里以 demo 中的 `hello` 资源为例。接下来，show me the code 。

### 添加 Sentinel 依赖

[](#添加-sentinel-依赖)

PHP 项目通常使用 composer 管理依赖，可配置使用阿里云镜像加速下载依赖，命令如下：

```
composer config -g repositories.packagist composer https://mirrors.aliyun.com/composer/
```

添加 sentinel 依赖，命令如下：

```
composer require ahas/sentinel dev-master --prefer-dist
```

> sentinel php 客户端暂未发布正式版本，暂安装 `dev-master` 开发版本， 使用 `--prefer-dist` 选项安装打包分发版本，以便从镜像站点加速下载。

通常在 PHP 源码文件头部引入 composer autoload 文件，以支持自动加载 PHP 类。类似如下代码：

```
require_once __DIR__ . "/vendor/autoload.php";
```

### 创建 Sentinel 客户端

[](#创建-sentinel-客户端)

Sentinel 客户端是调用 Sentinel 方法的入口， 只需要创建一个 Sentinel 客户端对象，供全局共享使用。 Sentinel 客户端使用简单 RPC 与本地 sidecar 进程通信， 创建 Sentinel 客户端时需要指定 sidecar 地址。 demo 启动 sidecar 默认地址为 localhost 9090 端口，创建 Sentinel 客户端示例代码如下：

```
// 创建 Sentinel 客户端
$sentinel = new \Sentinel\SentinelClient("localhost", 9090);
```

### 添加保护代码

[](#添加保护代码)

找到访问受保护资源的代码块。如 `index.php` 文件包含如下代码：

```
// 受保护的业务逻辑, sleep 200ms 模拟业务耗时。
echo "Killer Business!\n";
usleep(200 * 1000);
```

将受保护的业务逻辑放到 try 语句中。如下所示：

```
try {
	// 受保护的业务逻辑, sleep 200ms 模拟业务耗时。
	echo "Killer Business!\n";
	usleep(200 * 1000);
} finally {
}
```

为受保护的资源取一个名字，命名尽量简单清晰，这里使用 `hello` 为例。 执行受保护的代码前，即 try 语句开头，添加调用 `entry()` 方法获取资源访问入口。 该方法返回一个抽象表示资源正在被用户锁定访问的 SentinelEntry 对象 (简称入口对象) 。 如配置一个资源最多被 10 个用户同时访问，10 个用户同时访问时即存在 10 个入口对象锁定资源，此时第 11 个用户请求将被拒绝。

```
// 获取受保护的资源访问入口。
$sentinelHelloEntry = $sentinel->entry("hello");
```

**注意：** 获取资源访问入口后，必须定义一个变量保存入口对象 (如示例中的 `$sentinelHelloEntry` 变量) ，否则入口对象将被自动销毁并释放资源。 相反，受保护的代码执行完毕后，必须将对应的变量置为 null ，使不再有变量引用入口对象， 以销毁入口对象并通知 Sentinel 释放资源、允许接受新的请求。 请务必在 finally 子句中将保存入口对象的变量置为 null，以确保该逻辑被执行。 修改后的代码示例如下：

```
try {
	// 获取受保护的资源访问入口。
	// 注意: 必须定义一个变量保存入口对象, 否则入口对象将被自动销毁并释放资源。
	$sentinelHelloEntry = $sentinel->entry("hello");

	// 受保护的业务逻辑, sleep 200ms 模拟业务耗时。
	echo "Killer Business!\n";
	usleep(200 * 1000);
} finally {
    // 将保存入口对象的变量置为 null, 使不再有变量引用入口对象, 以销毁入口对象并释放资源。
    $sentinelHelloEntry = null;
}
```

> PHP 中 try 子句与 finally 子句作用域相同。 即使在 try 子句中获取入口对象失败，在 finally 子句中将变量置为 null 也不会有副作用。

### 添加限流处理

[](#添加限流处理)

请求压力超过限制时， `entry()` 方法抛出 `BlockException` 异常，阻止继续执行受保护的代码块，避免压垮后端系统。 此时可在 try 语句添加捕获此异常的 catch 子句，添加限流处理逻辑，如提示用户稍后再试等，让用户快速得到反馈提示。 这样即保护了后端系统 (挡住流量洪峰)，又可以改善前端用户的体验。

修改之后的 `index.php` 文件完整代码示例如下：

```