harness/ff-server-sdk

PHP 服务器 SDK,用于与 Harness 特性标志服务集成。

0.2.0-beta 2024-04-08 11:54 UTC

This package is auto-updated.

Last update: 2024-09-08 12:49:40 UTC


README

========================

目录

简介
要求
快速入门
进一步阅读
开发

简介

使用此 README 了解如何开始使用我们的 PHP 特性标志 (FF) SDK。本指南概述了使用 SDK 的基础知识,并提供了一个完整的代码示例供您尝试。此示例不包含配置选项,例如禁用流或使用我们的中继代理,请参阅 PHP SDK 参考文档进行深入了解。

FeatureFlags

要求

要使用此 SDK,请确保您已

  • 安装了 PHP 7.4 或更高版本 PHP
  • 安装了 Composer

一般依赖

快速入门

为了跟随我们的测试代码示例,请确保您已

安装 SDK 依赖项

第一步是将 SDK 作为依赖项安装到您的应用程序中,使用 Composer。

composer require harness/ff-server-sdk

代码示例

以下是一个完整的代码示例,您可以使用它来测试在 Harness 平台上创建的 harnessappdemodarkmode 标志。当您运行代码时,它将

  • 连接到 FF 服务。
  • 在网页上报告标志的值。每当在 Harness 平台上切换 harnessappdemodarkmode 标志的开关时,缓存刷新后,更新的值将被更新,然后刷新网页以查看新值。
  • 关闭 SDK。

以下示例也可在 online_example.php 中找到。

<?php

require_once realpath("vendor/autoload.php");

use Harness\Client;
use OpenAPI\Client\Model\Target;

$SDK_KEY = getenv("SDK_KEY") ?: "";  // you can put your key in env variable or you can provide in the code
$FLAG_NAME = "harnessappdemodarkmode";

$client = new Client($SDK_KEY, new Target(["name" => "harness", "identifier" => "harness"]));
$result = $client->evaluate($FLAG_NAME, false);

echo "Evaluation value for flag '".$FLAG_NAME."' with target 'harness': ".json_encode($result);

使用 Docker 运行示例

此项目包含快速使用 Docker 运行此代码示例的资源。为此,您需要

  • docker
  • docker-compose
  • make

首先为 FF 中继代理和 SDK 设置环境配置。

.online.example.env 复制到 .online.env

cp .online.example.env .online.env

然后编辑 .online.env 并添加以下来自您的 Harness 配置的值。

ACCOUNT_IDENTIFIER=<Add your Account Identifier>
ORG_IDENTIFIER=default
ADMIN_SERVICE=https://app.harness.io/gateway/cf
# You need to generate an ADMIN_SERVICE_TOKEN yourself and add it here
ADMIN_SERVICE_TOKEN=<Add your Admin Service Token>
CLIENT_SERVICE=https://config.ff.harness.io/api/1.0
AUTH_SECRET=<Auth Secret string to sign JWT>
SDK_BASE_URL=https://config.ff.harness.io/api/1.0
SDK_EVENTS_URL=https://events.ff.harness.io/api/1.0
REDIS_ADDRESS=redis:6379
REDIS_PASSWORD=
REDIS_DB=0
# These two keys are the client and server SDK keys for your FF Environment
API_KEYS=<Add Server SDK Key>,<Add Client SDK Key>

有关如何获取这些字段值的更多信息,请参阅:中继代理配置 特性标志 SDK 密钥

一旦配置好这些,使用以下命令启动 docker 容器

make start

一旦 docker 容器运行,请在浏览器窗口中打开 URL 以查看特性标志值。

https:///online_example.php

更多阅读

更多示例和配置选项在进一步阅读部分

进一步阅读

Harness 是一个特性管理平台,帮助团队构建更好的软件并更快地测试特性。