php-shared-data

php-shared-data

php 共享数据类

介绍

php 实现的共享数据类，用于本地服务进程之间共享数据

基于内存共享来实现进程间数据共享，进程间消息队列通讯

---

扩展依赖

基于 php 扩展实现，需要安装 shmop, sysvsem, sysvshm, sysvmsg 扩展

扩展说明

shmop 用于进程间内存共享数据

https://www.php.net/manual/zh/ref.shmop.php

sysvsem 用于信号量锁，控制并发

sysvshm 用于进程间 key value 形式内存共享数据

sysvmsg 用于进程间消息队列通讯

https://www.php.net/manual/zh/ref.sem.php

扩展安装

检查是否已安装 shmop, sysvsem, sysvshm, sysvmsg 扩展

php -m | grep shmop

php -m | grep sysvsem

php -m | grep sysvshm

php -m | grep sysvmsg

安装 shmop, sysvsem, sysvshm, sysvmsg 扩展

pecl install shmop

pecl install sysvsem

pecl install sysvshm

pecl install sysvmsg

Docker 环境安装

Docker 环境安装方法，参考 Docker

Docker 镜像已配置好 Nginx, PHP 及依赖的扩展

# 需将 /src 修改为本机目录
volumes:
      - /src:/data/webapp

docker-compose-web.yml 中，volumes /src 需自行修改为本机目录，并且此目录中需要包含 www 目录（Nginx root）

www 目录中存放可以访问的 php 文件，例如创建一个 demo.php 文件放此目录

启动，运行与关闭

# 启动 docker
docker-compose -f docker-compose-web.yml up -d

# 访问，端口可在 docker-compose-web.yml 中修改
http://localhost:8080/demo.php

# 进入容器
docker exec -it php_71_web bash

# 关闭 docker
docker-compose -f docker-compose-web.yml down

---

共享内存系统命令

查看已使用的共享内存块

ipcs -m

删除已使用的共享内存块

ipcrm -m [shm-id]

---

功能

共享数据

• 创建共享存储并写入数据

• 读取共享数据

• 清空共享数据

• 删除共享存储

KV 共享存储

• 创建 KV 共享存储并写入 KV 数据

• 读取 KV 共享数据

• 移除 KV 共享数据

• 删除 KV 共享存储

共享队列

• 创建共享队列

• 发送消息

• 接收消息

• 关闭共享队列

---

类说明

ISharedData SharedData/ISharedData.php

共享数据接口，定义共享数据实现类必须实现的方法

SharedMemory SharedData/SharedMemory.php

基于内存共享实现的共享数据类

IKVSharedStorage SharedData/IKVSharedStorage.php

共享 Key Value 存储数据接口，定义共享数据 KV 存储类需要实现的方法

KVSharedMemory SharedData/KVSharedMemory.php

基于共享内存实现的 KV 存储类

SharedMemoryUtils SharedData/SharedMemoryUtils.php

共享内存通用方法集合

---

演示

SharedMemory

$shared_key = 'test-shared-key';
$shared_size = 128;
$shared_memory = new \SharedData\SharedMemory($shared_key, $shared_size, true);

// 写入数据
$data = 'shared data';
$written = $shared_memory->store($data);
var_dump($written);

// 读取数据
$load_data = $shared_memory->load();
echo $load_data.PHP_EOL;

// 清空数据
$is_clear = $shared_memory->clear();
var_dump($is_clear);

// 关闭共享存储
$closed = $shared_memory->close();
var_dump($closed);

KVSharedMemory

$shared_key = 'test-shared-key';
$shared_size = 1024;
$kv_shared_memory = new \SharedData\KVSharedMemory($shared_key, $shared_size, true);

// 写入数据
$key1 = 'test1';
$data1 = 'shared data content';
$written = $kv_shared_memory->store($key1, $data1);
var_dump($written);

// 写入数组数据
$key2 = 'test2';
$data2 = array('name' => 'fdipzone');
$written = $kv_shared_memory->store($key2, $data2);
var_dump($written);

// 读取数据
$load_data = $kv_shared_memory->load($key1);
echo $load_data.PHP_EOL;

// 读取数组数据
$load_data = $kv_shared_memory->load($key2);
print_r($load_data);

// 移除 key2
$removed = $kv_shared_memory->remove($key2);
var_dump($removed);

// 关闭共享存储
$closed = $kv_shared_memory->close();
var_dump($closed);

SharedMemoryMsgQueue

$queue_name = 'test-shared-queue';
$max_message_size = 128;
$shared_memory_msg_queue = new \SharedData\SharedMemoryMsgQueue($queue_name, $max_message_size, true);

// 发送消息
$message = 'shared memory msg content';
$written = $shared_memory_msg_queue->send($message);
var_dump($written);

// 接收消息
$receive_message = $shared_memory_msg_queue->receive();
echo $receive_message.PHP_EOL;

// 关闭共享队列
$closed = $shared_memory_msg_queue->close();
var_dump($closed);

更多功能演示可参考单元测试代码 SharedData Unit Test