DTM PHP 客户端安装与使用指南

梅颖庚Sheridan

于 2024-09-11 07:47:36 发布

阅读量592

点赞数 21

本文链接：https://blog.csdn.net/gitblog_00346/article/details/142116938

版权

DTM PHP 客户端安装与使用指南

dtm-client A PHP coroutine client for distributed transaction manager DTM. 分布式事务管理器 DTM 的 PHP 协程客户端项目地址: https://gitcode.com/gh_mirrors/dt/dtm-client

1. 目录结构及介绍

DTM 的 PHP 客户端存储在 dtm-php/dtm-client 中，其基本目录结构大致如下：

.
├── composer.json                 # 依赖管理文件
├── gitattributes                 # Git属性设置文件
├── gitignore                     # 忽略文件列表
├── php-cs-fixer                  # PHP代码风格修复配置
├── phpstan.neon                  # PHPStan静态分析配置
├── phpunit.xml                   # PHPUnit测试配置
├── README.md                     # 主要英文版本的读我文件
├── README-CN.md                  # 中文版读我文件，详细介绍项目
├── class_map                     # 可能包含类映射或自动生成的辅助文件夹
├── publish                       # 配置发布相关文件夹
│   └── dtm.php                  # 示例配置文件，用于非Hyperf框架的配置指引
├── src                           # 核心源码目录
│   ├── ...
├── tests                         # 测试代码目录
│   ├── ...
└── vendor                        # Composer依赖包存放目录

src 目录包含了客户端的核心逻辑实现。
tests 包含了单元测试用例，以确保代码质量。
publish 提供了配置示例，指导如何在应用中集成配置。
README-CN.md 和 README.md 分别是中文和英文版本的文档，是了解项目的关键入口。

2. 项目的启动文件介绍

此PHP客户端本身并不直接提供一个"启动文件"，因为它的角色主要是作为库被其他PHP应用程序所引入和使用的。然而，如果你打算开始一个新的项目或者集成DTM服务，通常的起点将是通过Composer添加此库为依赖，并在你的应用初始化阶段配置和实例化DTM客户端。

添加依赖

首先，在你的项目根目录下运行以下命令来添加DTM PHP客户端的依赖：

composer require dtm-php/dtm-client

随后，在你的应用启动流程中，根据项目需求配置并初始化DTM客户端。

3. 项目的配置文件介绍

配置DTM客户端主要涉及创建或修改一个配置数组，该数组常被推荐放在你的应用配置文件中。虽然没有固定的“启动”文件来加载配置，但您可以参考提供的publish/dtm.php示例文件来理解和设定配置。典型的配置项包括：

protocol - 客户端与DTM服务器之间的通信协议（HTTP或GRPC）。
server - DTM服务器地址，默认为127.0.0.1。
port - DTM服务器对应的端口（HTTP和GRPC分别配置）。
barrier - 事务屏障的配置，支持数据库（如MySQL）和Redis模式等。
apply - 在不使用Hyperf框架或注解方式时，应用子事务屏障的具体配置。
guzzle.options - 当使用HTTP协议时，Guzzle客户端的额外选项。

例如，简单的配置示例可以在你的应用配置文件中这样定义：

return [
    'protocol' => \DtmClient\Constants\Protocol::HTTP,
    'server' => '127.0.0.1',
    'port' => [
        'http' => 36789,
    ],
    // 其他配置项...
];

确保根据实际部署环境调整这些值。为了全面的功能启用和最佳实践，强烈建议详细阅读DTM官方文档以及客户端的README-CN.md中的说明。

dtm-client A PHP coroutine client for distributed transaction manager DTM. 分布式事务管理器 DTM 的 PHP 协程客户端项目地址: https://gitcode.com/gh_mirrors/dt/dtm-client