1. Go to this page and download the library: Download dtm/dtm-client library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
dtm / dtm-client example snippets
use DtmClient\Constants\Protocol;
use DtmClient\Constants\DbType;
return [
// The communication protocol between the client and the DTM Server, supports Protocol::HTTP and Protocol::GRPC
'protocol' => Protocol::HTTP,
// DTM Server address
'server' => '127.0.0.1',
// DTM Server port
'port' => [
'http' => 36789,
'grpc' => 36790,
],
// Sub-transaction barrier
'barrier' => [
// Subtransaction barrier configuration in DB mode
'db' => [
'type' => DbType::MySQL
],
// Subtransaction barrier configuration in Redis mode
'redis' => [
// Timeout for subtransaction barrier records
'expire_seconds' => 7 * 86400,
],
// Classes that apply sub-transaction barriers in non-Hyperf frameworks or without annotation usage
'apply' => [],
],
// Options of Guzzle client under HTTP protocol
'guzzle' => [
'options' => [],
],
];
namespace App\Controller;
use DtmClient\TCC;
use DtmClient\TransContext;
use Hyperf\Di\Annotation\Inject;
use Hyperf\HttpServer\Annotation\Controller;
use Hyperf\HttpServer\Annotation\GetMapping;
use Throwable;
#[Controller(prefix: '/tcc')]
class TccController
{
protected string $serviceUri = 'http://127.0.0.1:9501';
#[Inject]
protected TCC $tcc;
#[GetMapping(path: 'successCase')]
public function successCase()
{
try {
$this->tcc->globalTransaction(function (TCC $tcc) {
// Create call data for subtransaction A
$tcc->callBranch(
// Arguments for calling the Try method
['amount' => 30],
// URL of Try stage
$this->serviceUri . '/tcc/transA/try',
// URL of Confirm stage
$this->serviceUri . '/tcc/transA/confirm',
// URL of Cancel stage
$this->serviceUri . '/tcc/transA/cancel'
);
// Create call data for subtransaction B, and so on
$tcc->callBranch(
['amount' => 30],
$this->serviceUri . '/tcc/transB/try',
$this->serviceUri . '/tcc/transB/confirm',
$this->serviceUri . '/tcc/transB/cancel'
);
});
} catch (Throwable $e) {
var_dump($e->getMessage(), $e->getTraceAsString());
}
// Get the global transaction ID through TransContext::getGid() and return it to the client
return TransContext::getGid();
}
}
namespace App\Controller;
use DtmClient\Saga;
use DtmClient\TransContext;
use Hyperf\Di\Annotation\Inject;
use Hyperf\HttpServer\Annotation\Controller;
use Hyperf\HttpServer\Annotation\GetMapping;
#[Controller(prefix: '/saga')]
class SagaController
{
protected string $serviceUri = 'http://127.0.0.1:9501';
#[Inject]
protected Saga $saga;
#[GetMapping(path: 'successCase')]
public function successCase(): string
{
$payload = ['amount' => 50];
// Init Saga global transaction
$this->saga->init();
// Add TransOut sub-transaction
$this->saga->add(
$this->serviceUri . '/saga/transOut',
$this->serviceUri . '/saga/transOutCompensate',
$payload
);
// Add TransIn sub-transaction
$this->saga->add(
$this->serviceUri . '/saga/transIn',
$this->serviceUri . '/saga/transInCompensate',
$payload
);
// Submit Saga global transaction
$this->saga->submit();
// Get the global transaction ID through TransContext::getGid() and return it to the client
return TransContext::getGid();
}
}
namespace App\Controller;
use App\Grpc\GrpcClient;
use DtmClient\DbTransaction\DBTransactionInterface;
use DtmClient\TransContext;
use DtmClient\XA;
use Hyperf\Contract\ConfigInterface;
use Hyperf\Di\Annotation\Inject;
use Hyperf\HttpServer\Annotation\Controller;
use Hyperf\HttpServer\Annotation\GetMapping;
use Hyperf\HttpServer\Annotation\RequestMapping;
use Hyperf\HttpServer\Contract\RequestInterface;
use Psr\Http\Message\ResponseInterface;
#[Controller(prefix: '/xa')]
class XAController
{
private GrpcClient $grpcClient;
protected string $serviceUri = 'http://127.0.0.1:9502';
public function __construct(
private XA $xa,
protected ConfigInterface $config,
) {
$server = $this->config->get('dtm.server', '127.0.0.1');
$port = $this->config->get('dtm.port.grpc', 36790);
$hostname = $server . ':' . $port;
$this->grpcClient = new GrpcClient($hostname);
}
#[GetMapping(path: 'successCase')]
public function successCase(): string
{
$payload = ['amount' => 50];
// Open the Xa, the global thing
$gid = $this->xa->generateGid();
$this->xa->globalTransaction($gid, function () use ($payload) {
// Call the subthings interface
$respone = $this->xa->callBranch($this->serviceUri . '/xa/api/transIn', $payload);
// Get subthings return structure in XA http mode
/* @var ResponseInterface $respone */
$respone->getBody()->getContents();
// Call the subthings interface
$payload = ['amount' => 10];
$this->xa->callBranch($this->serviceUri . '/xa/api/transOut', $payload);
});
// Return the global transaction ID via TransContext:: getGid()
return TransContext::getGid();
}
#[RequestMapping(methods: ["GET", "POST", "PUT"], path: 'api/transIn')]
public function transIn(RequestInterface $request): array
{
$content = $request->post('amount');
$amount = $content['amount'] ?? 50;
// The transIn method under the simulated distributed system
$this->xa->localTransaction(function (DBTransactionInterface $dbTransaction) use ($amount) {
// Please use the DBTransactionInterface to handle the local Mysql things
$dbTransaction->xaExecute('UPDATE `order` set `amount` = `amount` + ? where id = 1', [$amount]);
});
return ['status' => 0, 'message' => 'ok'];
}
/**
* @param RequestInterface $request
* @return array
*/
#[RequestMapping(methods: ["GET", "POST", "PUT"], path: 'api/transOut')]
public function transOut(RequestInterface $request): array
{
$content = $request->post('amount');
$amount = $content['amount'] ?? 10;
// The transOut method under the simulated distributed system
$this->xa->localTransaction(function (DBTransactionInterface $dbTransaction) use ($amount) {
// Please use the DBTransactionInterface to handle the local Mysql things
$dbTransaction->xaExecute('UPDATE `order` set `amount` = `amount` - ? where id = 2', [$amount]);
});
return ['status' => 0, 'message' => 'ok'];
}
}