@ackee/petrus 中文文档教程

Question

Petrus

该库使用基于令牌的流程处理身份验证逻辑。

Main features

• automatically refresh access token before it expires
• persisting tokens state in local or session storage (optional)
• automatically fetching an authorized user after successful tokens retrieval from a persistent storage
• simple API for auth state management: getAuthStateChannel, withAuthSession
• authorizable HOC - render content (a firewall, an authorized content or a loader) based on current auth. state

Requirements

该库依赖于 react、redux、react-redux、redux-saga 和 reselect 打包为对等依赖项。

---

Table of contents

• Installing
• Usage
• Usage Examples
• API Reference
  • Components
  • Action creators
  • Action types
  • Constants
  • Selectors
  • Utilities
  • HOC

---

Installing

使用 yarn：

$ yarn add @ackee/petrus

使用 npm：

$ npm i -S @ackee/petrus

Usage

Minimal required configuration

import { configure } from '@ackee/petrus';

// 1. Provide authenticate, refreshTokens and getAuthUser methods
const { saga, reducer } = configure({
    handlers: {
        authenticate,
        refreshTokens,
        getAuthUser,
    },
});

// 2. Add auth reducer
const rootReducer = combineReducers({
    auth: reducer
});

// 3. And launch the saga
function*() {
    yield all([saga()])
}

要通过示例查看默认值和可用配置，请转到此处。

Usage with @ackee/antonio

HTTP 客户端 @ackee/antonio 的最低要求配置还需要将 applyAccessTokenExternally 选项设置为 true。 否则 Authorization 标头将不会被设置，因此每个身份验证。 请求将导致 401 错误。

import { configure } from '@ackee/petrus';

// 1. Provide authenticate, refreshTokens and getAuthUser methods
const { saga, reducer } = configure({
    handlers: {
        authenticate,
        refreshTokens,
        getAuthUser,
    },
    tokens: {
        applyAccessTokenExternally: true,
    },
});

// 2. Add auth reducer
const rootReducer = combineReducers({
    auth: reducer
});

// 3. And launch the saga
function*() {
    yield all([saga()])
}

With OAuth2

@ackee/petrus 支持以下 OAuth2 流程：

• Implicit grant flow
  • Matches with the default configuration.
  • origin property is required
• Web application flow
  • Additionally to the Implicit grant flow, you have to provide the fetchAccessToken method.

查看如何为这些流程设置 @ackee/petrus 此处< /a>。