@ably-labs/react-hooks 中文文档教程

Question

ably-react-hooks

使用惯用的、易于使用的 React Hooks 在你的 React 应用程序中使用 Ably！

使用此包，您可以：

• Interact with Ably channels using a react hook.
• Send messages via Ably using the channel instances the hooks provide
• Get notifications of user presence on channels
• Send presence updates

挂钩提供了与 Ably 交互的简化语法，并管理 Ably SDK 实例的生命周期，以便您在 React 组件重新渲染时注意订阅和取消订阅频道和事件。

Installation

这些钩子作为 ES6 模块发布，因此您可以在 React 代码中使用 import 语法。

npm install --save @ably-labs/react-hooks

这可以使用 create-react-app 开箱即用 - 您可以立即使用该包。

Ably channels and API keys

为了使用这些钩子，您需要一个 Ably API 密钥。 如果您尚未注册，可以立即注册一个免费的 Ably 帐户。 拥有 Ably 帐户后：

1. Log into your app dashboard.
2. Under “Your apps”, click on “Manage app” for any app you wish to use for this tutorial, or create a new one with the “Create New App” button.
3. Click on the “API Keys” tab.
4. Copy the secret “API Key” value from your Root key, we will use this later when we build our app.

强烈建议您使用令牌身份验证，这将需要超出本自述文件范围的服务器端代码。 在下面的示例中，我们直接在标记中使用 API 密钥，这用于*仅本地开发并且不应用于生产代码并且不应< /strong> 致力于您的存储库。

Usage

使用 npm 将包添加到项目后，您可以在 react 代码中使用挂钩。

首先添加对挂钩的引用

import { configureAbly, useChannel } from "@ably-labs/react-hooks";

然后您需要使用 configureAbly 函数创建 Ably JavaScript SDK 的实例。

configureAbly({ key: "your-ably-api-key", clientId: generateRandomId() });

configureAbly 匹配 Ably SDK 的方法签名 - 并且需要 string 或 AblyClientOptions。 您可以使用此配置对象来设置您的 API 密钥，或者像往常一样设置 tokenAuthentication。 如果您想使用 usePresence 挂钩，您需要明确提供一个 clientId。

完成此操作后，您可以在代码中使用 hooks。 最简单的示例如下：

const [channel] = useChannel("your-channel-name", (message) => {
    console.log(message);
});

每次将消息发送到 your-channel-name 时，它都会被记录到控制台。 您可以对这些消息做任何您需要做的事情。

useChannel

useChannel 钩子可以让你订阅一个频道并从中接收消息。

```javascript
const [channel, ably] = useChannel("your-channel-name", (message) => { 控制台日志（消息）； });

Both the channel instance, and the Ably JavaScript SDK instance are returned from the useChannel call.

`useChannel` really shines when combined with a regular react `useState` hook - for example, you could keep a list of messages in your app state, and use the `useChannel` hook to subscribe to a channel, and update the state when new messages arrive.

javascript const [消息，updateMessages] = useState([]); const [channel] = useChannel("你的频道名称", (message) => { updateMessages((prev) => […prev, message]); });

// 将消息转换为列表项以在 React 组件中呈现 const messagePreviews = messages.map((msg, index) =>

{msg.data.someProperty}

);

`useChannel` supports all of the parameter combinations of a regular call to `channel.subscribe`, so you can filter the messages you subscribe to by providing a `message type` to the `useChannel` function:

javascript
const [channel] = useChannel("your-channel-name", "test-message", (message) => { 控制台日志（消息）； // 仅记录使用 test-message 消息类型发送的消息 });

The `channel` instance returned by `useChannel` can be used to send messages to the channel. It's just a regular Ably JavaScript SDK `channel` instance.

javascript channel.publish("test-message", { text: "message text" });

## usePresence

The usePresence hook lets you subscribe to presence events on a channel - this will allow you to get notified when a user joins or leaves the channel.

javascript const [presenceData, updateStatus] = usePresence("你的频道名称");

// 将存在数据转换为要呈现的列表项
const peers = presenceData.map((msg, index) =>

{msg.clientId}: {msg.data}

);

`usePresence` returns an array of presence messages - again each message is a regular Ably JavaScript SDK `presenceMessage` instance.

You can optionally provide a string when you `usePresence` to set an initial `presence data` string.

javascript const [presenceData, updateStatus] = usePresence("your-channel-name", "initial state");

The `updateStatus` function can be used to update the presence data for the current client:

javascript updateStatus("新状态"); ```

新状态将被发送到频道，订阅该频道的任何其他客户端将立即收到更改通知。