通用 supervisor 行为。

此行为模块提供了一个 supervisor，这是一个监控其他进程（称为子进程）的进程。子进程可以是另一个 supervisor 或工作进程。工作进程通常使用 gen_event、 gen_server 或 gen_statem 行为之一来实现。使用此模块实现的 supervisor 具有一组标准的接口函数，并包含用于跟踪和错误报告的功能。Supervisor 用于构建一个称为监管树的层次进程结构，这是一种构建容错应用程序的好方法。有关详细信息，请参阅 OTP 设计原则中的 Supervisor 行为。

supervisor 希望在导出预定义函数集的回调模块中指定要监管的子进程的定义。

除非另有说明，否则如果指定的 supervisor 不存在或指定了错误的参数，则此模块中的所有函数都将失败。

监管原则

supervisor 负责启动、停止和监视其子进程。supervisor 的基本思想是，它必须通过在必要时重新启动子进程来保持子进程的活动状态。

supervisor 的子进程被定义为子进程规范的列表。当 supervisor 启动时，子进程会按照此列表从左到右的顺序启动。当 supervisor 即将终止时，它首先按照相反的启动顺序（从右到左）终止其子进程。

Supervisor 标志

supervisor 的属性由 supervisor 标志定义。supervisor 标志的类型定义如下

sup_flags() = #{strategy => strategy(),           % optional
                intensity => non_neg_integer(),   % optional
                period => pos_integer(),          % optional
                auto_shutdown => auto_shutdown()} % optional

重启策略

supervisor 可以使用上面映射中的 strategy 键指定以下重启策略之一

• one_for_one - 如果一个子进程终止并要重新启动，则只会影响该子进程。这是默认的重启策略。

• one_for_all - 如果一个子进程终止并要重新启动，则所有其他子进程都会终止，然后重新启动所有子进程。

• rest_for_one - 如果一个子进程终止并要重新启动，则终止“其余”的子进程（即，启动顺序中终止的子进程之后的子进程）。然后重新启动终止的子进程及其后的所有子进程。

• simple_one_for_one - 简化的 one_for_one supervisor，其中所有子进程都是相同进程类型的动态添加实例，即运行相同的代码。

  函数 delete_child/2 和 restart_child/2 对于 simple_one_for_one supervisor 无效，如果指定的 supervisor 使用此重启策略，则返回 {error,simple_one_for_one}。

  可以通过指定子进程的 pid/0 作为第二个参数来使用函数 terminate_child/2 处理 simple_one_for_one supervisor 下的子进程。如果改为使用子进程规范标识符，则 terminate_child/2 返回 {error,simple_one_for_one}。

  由于 simple_one_for_one supervisor 可以有多个子进程，因此它会异步关闭所有子进程。这意味着子进程并行执行清理，因此停止它们的顺序未定义。

重启强度和周期

为了防止 supervisor 进入子进程终止和重启的无限循环，使用上面映射中的键 intensity 和 period 指定两个整数值来定义最大重启强度。假设 intensity 的值为 MaxR，period 的值为 MaxT，那么如果在 MaxT 秒内发生超过 MaxR 次重启，则 supervisor 会终止所有子进程，然后终止自身。在这种情况下，supervisor 自身的终止原因是 shutdown。intensity 默认为 1，period 默认为 5。

自动关闭

可以配置 supervisor 在 重要子进程 以 shutdown 的退出原因终止时，使用上面映射中的 auto_shutdown 键自动关闭自身

• never - 禁用自动关闭。这是默认设置。

  当 auto_shutdown 设置为 never 时，将 significant 标志设置为 true 的子进程规范被认为是无效的，并且会被拒绝。

• any_significant - 当任何重要子进程终止时，supervisor 将关闭自身，即当 transient 重要子进程正常终止，或者当 temporary 重要子进程正常或异常终止时。

• all_significant - 当所有重要子进程都终止时，supervisor 将关闭自身，即当最后一个活动重要子进程终止时。与 any_significant 相同的规则适用。

有关详细信息，请参阅 OTP 设计原则中 Supervisor 行为部分的 自动关闭。

警告

自动关闭功能出现在 OTP 24.0 中，但使用此功能的应用程序也可以使用较旧的 OTP 版本进行编译和运行。

但是，当使用早于自动关闭功能出现的 OTP 版本编译此类应用程序时，会发生进程泄漏，因为它们所依赖的自动关闭不会发生。

如果实现者预计他们的应用程序可能会使用较旧的 OTP 版本进行编译，则由他们采取适当的预防措施。

子进程规范

子进程规范的类型定义如下

child_spec() = #{id => child_id(),             % mandatory
                 start => mfargs(),            % mandatory
                 restart => restart(),         % optional
                 significant => significant(), % optional
                 shutdown => shutdown(),       % optional
                 type => worker(),             % optional
                 modules => modules()}         % optional

旧的元组格式保留用于向后兼容，请参阅 child_spec/0，但首选映射。

• id 由 supervisor 在内部用于标识子进程规范。

  id 键是强制性的。

  请注意，此标识符有时被称为“name”。在可能的情况下，现在使用术语“identifier”或“id”，但为了保持向后兼容性，仍然可以找到一些“name”的出现，例如在错误消息中。

• start 定义用于启动子进程的函数调用。它必须是一个模块-函数-参数元组 {M,F,A}，用作 apply(M,F,A)。

  启动函数必须创建并链接到子进程，并且必须返回 {ok,Child} 或 {ok,Child,Info}，其中 Child 是子进程的 pid，Info 是任何被 supervisor 忽略的项。

  如果由于某种原因无法启动子进程，则启动函数也可以返回 ignore，在这种情况下，supervisor 会保留子进程规范（除非它是临时子进程），但会忽略不存在的子进程。

  如果出现问题，该函数还可以返回错误元组 {error,Error}。

  请注意，不同行为模块的 start_link 函数满足上述要求。

  start 键是强制性的。

• restart 定义何时必须重新启动已终止的子进程。permanent 子进程始终重新启动。temporary 子进程永远不会重新启动（即使 supervisor 的重启策略是 rest_for_one 或 one_for_all 并且同级的死亡导致临时进程终止）。仅当 transient 子进程异常终止时，才重新启动它，即，使用 normal、shutdown 或 {shutdown,Term} 之外的其他退出原因。

  restart 键是可选的。如果未指定，则默认为 permanent。

• significant 定义对于 supervisor 的 自动自关闭，是否认为子进程是重要的。

  当 重启类型 为 permanent 时，将此选项设置为 true 无效。此外，当 auto_shutdown supervisor 标志设置为 never 时，在此 supervisor 中启动将此选项设置为 true 的子进程也被认为是无效的。

  significant 键是可选的。如果未指定，则默认为 false。

• shutdown 定义如何终止子进程。brutal_kill 表示使用 exit(Child,kill) 无条件终止子进程。整数超时值表示 supervisor 通过调用 exit(Child,shutdown) 来告诉子进程终止，然后等待子进程返回带有 shutdown 原因的退出信号。如果在指定的毫秒数内未收到退出信号，则使用 exit(Child,kill) 无条件终止子进程。

  如果子进程是另一个 supervisor，则必须将关闭时间设置为 infinity，以给子树充分的时间关闭。

  警告

  对于类型为 supervisor 的子进程，如果将其关闭时间设置为除 infinity 以外的任何值，都可能导致竞态条件：该子进程会取消链接自己的子进程，但在被终止前未能将其终止。

  如果子进程是 worker，则允许将其关闭时间设置为 infinity。

  警告

  当子进程是 worker 时，设置关闭时间为 infinity 时要小心。因为在这种情况下，监督树的终止取决于子进程，因此必须以安全的方式实现，并且其清理过程必须始终返回。

  请注意，所有使用标准 OTP 行为模块实现的子进程都会自动遵循关闭协议。

  shutdown 键是可选的。如果未指定，则当子进程类型为 worker 时，默认为 5000；当子进程类型为 supervisor 时，默认为 infinity。

• type 指定子进程是 supervisor 还是 worker。

  type 键是可选的。如果未指定，则默认为 worker。

• modules 在代码替换期间被 release 处理程序用来确定哪些进程正在使用特定的模块。一般而言，如果子进程是 supervisor、gen_server 或 gen_statem，则此值应为一个包含一个元素的列表 [Module]，其中 Module 是回调模块。如果子进程是一个事件管理器 (gen_event)，并且具有动态的回调模块集，则必须使用值 dynamic。有关 release 处理的更多信息，请参阅 OTP 设计原则中的 Release Handling。

  modules 键是可选的。如果未指定，则默认为 [M]，其中 M 来自子进程的启动 {M,F,A}。

• 在内部，supervisor 还会跟踪子进程的 pid Child，如果没有 pid，则为 undefined。

另请参阅

gen_event, gen_statem, gen_server, sys