WeChat.Refresher.Default (wechat v0.19.0)

View Source

AccessToken 刷新器 - 用于定时刷新 AccessToken

官方说明

本模块为默认的刷新器

需要修改为自定义的刷新器，可以这样配置：

config :wechat, :refresher, YourRefresher

修改刷新器的配置，支持多种配置方式：

方式1

config :wechat, :refresh_settings, [ClientA, ClientB, ClientC]

以上配置会自动为三个 Client 定时刷新 AccessToken ， 默认会在 AccessToken 过期前 30 分钟刷新， AccessToken 刷新失败的重试间隔为 1 分钟， 可以通过接口 获取默认的 AccessToken 刷新列表：WeChat.Refresher.DefaultSettings.get_refresh_options_by_client/1

方式2

config :wechat, :refresh_settings, [{ClientA, client_setting}, ClientB, ClientC]
# or
config :wechat, :refresh_settings, %{ClientA => client_setting, ClientB => client_setting, ClientC => client_setting}

client_setting 配置说明见：client_setting/0

为了适应 Storage 在 Refresher 启动之后才启动，可以开启延时启动刷新:

config :wechat, WeChat.Refresher.Default, wait_for_signal: true

当所有的 Storage 都已经完成，可以即可通过 WeChat.Refresher.Default.start_monitor/0 方法刷新 AccessToken

不配置默认为立即启动刷新

Summary

Types

client_setting()

option

client_settings()
refresh_before_expired()

在 AccessToken 超时前多少秒刷新，单位：秒

refresh_retry_interval()

刷新 AccessToken 失败的重试间隔，单位：秒

state()

Functions

add(client, opts \\ %{})
append_work_agent(client, agent)
child_spec(init_arg)

Returns a specification to start this module under a supervisor.

client_options(client)
clients()
components()
refresh(client)
refresh(client, store_id, store_key)
refresh_component(component_appid, store_key)
refresh_key(client, store_id, store_key, value, expires)
remove(client)
start_link(client_settings \\ %{})
start_monitor()

Types

client_setting()

@type client_setting() :: %{
  optional(:refresh_before_expired) => refresh_before_expired(),
  optional(:refresh_retry_interval) => refresh_retry_interval(),
  optional(:refresh_options) =>
    WeChat.Refresher.DefaultSettings.refresh_options()
}

option

  • :refresh_before_expired: 在 AccessToken 超时前多少秒刷新，单位：秒，可选， 为保证 hub & hub_client 刷新正常，请保持两者的时间一致； server_role=hub_client 时, 默认值：1800 + 30 秒； 其余角色默认值：1800 秒
  • :refresh_retry_interval: 刷新 AccessToken 失败的重试间隔，单位：秒，可选，默认值：60000 秒
  • :refresh_options: 刷新 AccessToken 配置，可选，默认值：WeChat.Refresher.DefaultSettings.get_refresh_options_by_client/1 的输出结果

client_settings()

@type client_settings() ::
  [WeChat.client()] | %{required(WeChat.client()) => client_setting()}

refresh_before_expired()

@type refresh_before_expired() :: non_neg_integer()

在 AccessToken 超时前多少秒刷新，单位：秒

如果server_role = hub, hub server 的值请大于 hub client

refresh_retry_interval()

@type refresh_retry_interval() :: non_neg_integer()

刷新 AccessToken 失败的重试间隔，单位：秒

state()

@type state() :: %{
  :wait_for_signal => boolean(),
  :clients => [WeChat.client()],
  required(WeChat.client()) => client_setting()
}

Functions

add(client, opts \\ %{})

@spec add(WeChat.client(), client_setting()) :: :ok

append_work_agent(client, agent)

@spec append_work_agent(WeChat.client(), WeChat.Work.Agent.t()) ::
  :ok | :client_not_in

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

client_options(client)

@spec client_options(WeChat.client()) :: client_setting() | nil

clients()

@spec clients() :: [WeChat.client()]

components()

@spec components() :: %{
  required(WeChat.component_appid()) => %{
    keys: [WeChat.Storage.Adapter.store_key()],
    clients: [WeChat.client()]
  }
}

refresh(client)

@spec refresh(WeChat.client()) :: :ok | :not_found

refresh(client, store_id, store_key)

@spec refresh(
  WeChat.client(),
  WeChat.Storage.Adapter.store_id(),
  WeChat.Storage.Adapter.store_key()
) ::
  :ok | :not_found

refresh_component(component_appid, store_key)

@spec refresh_component(WeChat.component_appid(), WeChat.Storage.Adapter.store_key()) ::
  :ok | :not_found

refresh_key(client, store_id, store_key, value, expires)

@spec refresh_key(
  WeChat.client(),
  WeChat.Storage.Adapter.store_id(),
  WeChat.Storage.Adapter.store_key(),
  WeChat.Storage.Adapter.value(),
  expires :: integer()
) :: :ok

remove(client)

@spec remove(WeChat.client()) :: :ok | :not_found

start_link(client_settings \\ %{})

@spec start_link(client_settings()) :: GenServer.on_start()

start_monitor()

@spec start_monitor() :: :ok