---
title: '上下文 (Contexts)'
sidebar_label: Contexts
description: '使用上下文传递深度嵌套数据'
---

通常，数据是通过 props 从父组件传递到子组件。
但是，如果必须通过中间的许多组件传递它们，或者如果应用程序中的许多组件需要相同的信息，传递 props 可能会变得冗长和烦人。
上下文解决了这个问题，允许父组件使数据可用于其下方树中的任何组件，无论多深，而无需通过 props 传递它们。

## 使用 props 的问题："Prop Drilling"

传递 [props](./function-components/properties.mdx) 是从父组件直接传递数据到子组件的好方法。
但是，当需要通过深层嵌套的组件树传递数据或多个组件共享相同的数据时，传递 props 变得繁琐。
一种常见的数据共享解决方案是将数据提升到一个共同的祖先，并使子组件将其作为 props 接收。
然而，这可能导致 props 必须通过多个组件才能到达需要它的组件。
这种情况称为 "Prop Drilling"。

考虑以下示例，它通过 props 传递主题：

```rust
use yew::{html, Component, Context, Html, Properties, function_component};

#[derive(Clone, PartialEq)]
pub struct Theme {
    foreground: String,
    background: String,
}

#[derive(PartialEq, Properties)]
pub struct NavbarProps {
    theme: Theme,
}

#[function_component]
fn Navbar(props: &NavbarProps) -> Html {
    html! {
        <div>
            <Title theme={props.theme.clone()}>
                { "App title" }
            </Title>
            <NavButton theme={props.theme.clone()}>
                { "Somewhere" }
            </NavButton>
        </div>
    }
}

#[derive(PartialEq, Properties)]
pub struct ThemeProps {
    theme: Theme,
    children: Html,
}

#[function_component]
fn Title(_props: &ThemeProps) -> Html {
    html! {
        // impl
    }
}

#[function_component]
fn NavButton(_props: &ThemeProps) -> Html {
    html! {
        // impl
    }
}

/// App 根节点
#[function_component]
fn App() -> Html {
    let theme = Theme {
        foreground: "yellow".to_owned(),
        background: "pink".to_owned(),
    };

    html! {
        <Navbar {theme} />
    }
}
```

我们通过 `Navbar` 传递主题设定，以便它可以到达 `Title` 和 `NavButton`。
如果 `Title` 和 `NavButton` 这些需要访问主题的组件可以直接访问主题而不必通过 prop 传递，那就更好了。
上下文解决了这个问题，允许父组件将数据（在这种情况下是主题）传递给其子组件。

## 使用上下文

### 步骤 1：提供上下文

需要一个上下文提供者来消费上下文。`ContextProvider<T>`，其中 `T` 是用作提供者的上下文结构体。
`T` 必须实现 `Clone` 和 `PartialEq`。`ContextProvider` 是其子组件将拥有上下文的组件。
当上下文更改时，子组件会重新渲染。一个结构体用于定义要传递的数据。`ContextProvider` 可以这样使用：

```rust
use yew::prelude::*;

/// App 主题
#[derive(Clone, Debug, PartialEq)]
struct Theme {
    foreground: String,
    background: String,
}

/// 主组件
#[function_component]
pub fn App() -> Html {
    let ctx = use_state(|| Theme {
        foreground: "#000000".to_owned(),
        background: "#eeeeee".to_owned(),
    });

    html! {
        // `ctx` 是 `Rc<UseStateHandle<Theme>>` 类型，而我们需要 `Theme`
        // 所以我们对它进行解引用。
        <ContextProvider<Theme> context={(*ctx).clone()}>
            // 这里的每个子组件及其子组件都将访问此上下文。
            <Toolbar />
        </ContextProvider<Theme>>
    }
}

/// 工具栏
/// 此组件可以访问上下文。
#[function_component]
pub fn Toolbar() -> Html {
    html! {
        <div>
            <ThemedButton />
        </div>
    }
}

/// 放置在 `Toolbar` 中的按钮
/// 由于此组件是组件树中 `ThemeContextProvider` 的子组件，它也可以访问上下文。
#[function_component]
pub fn ThemedButton() -> Html {
    let theme = use_context::<Theme>().expect("no ctx found");

    html! {
        <button style={format!("background: {}; color: {};", theme.background, theme.foreground)}>
            { "Click me!" }
        </button>
    }
}
```

### 步骤 2：使用上下文

#### 函数组件

`use_context` 钩子用于在函数组件中使用上下文。
请参阅 [use_context 文档](https://yew-rs-api.web.app/next/yew/functional/fn.use_context.html) 了解更多信息。

#### 结构体组件

我们有两种选择在结构体组件中使用上下文：

- [高阶组件](../advanced-topics/struct-components/hoc.mdx)：一个高阶函数组件将使用上下文并将数据传递给需要它的结构体组件。
- 直接在结构体组件中使用上下文。请参阅 [结构体组件作为消费者的示例](https://github.com/yewstack/yew/tree/master/examples/contexts/src/struct_component_subscriber.rs)

## 使用场景

通常，如果某些数据需要在树的不同部分的远程组件中使用，上下文可能会对你有所帮助。
以下是一些这样的例子：

- **主题**：你可以在应用程序的顶部放置一个上下文来保存你的应用程序主题，并使用它来调整视觉外观，如上例所示。
- **当前用户帐户**：在许多情况下，组件需要知道当前登录的用户。你可以使用上下文将当前用户对象提供给组件。

### 使用上下文前的考虑

上下文非常容易使用，这也使得它们非常容易被误用/过度使用。
仅仅因为你可以使用上下文将 props 共享给多个层级深的组件，并不意味着你应该这样做。

例如，你可以提取一个组件并将该组件作为子组件传递给另一个组件。例如，
你可能有一个 `Layout` 组件，它将 `articles` 作为 prop 并传递给 `ArticleList` 组件。
你应该重构 `Layout` 组件，使其接受子组件作为 props 并显示 `<Layout> <ArticleList {articles} /> </Layout>`。

## 修改子组件的上下文值

由于 Rust 的所有权规则，上下文不能有一个可以被子组件调用的 `&mut self` 方法。
要修改上下文的值，我们必须将其与 reducer 结合使用。这可以通过使用
[`use_reducer`](https://yew-rs-api.web.app/next/yew/functional/fn.use_reducer.html) 钩子来完成。

[上下文示例](https://github.com/yewstack/yew/tree/master/examples/contexts) 演示了使用上下文的可变上下文

## 进一步阅读

- [上下文示例](https://github.com/yewstack/yew/tree/master/examples/contexts)
