@auth0/angular-jwt

中文文档
5.2.0发布于 2023/10/31MITTypeScriptES Module构建来源已验证近 30 天下载 134.4万

用于 Angular 的 JSON Web Token 助手库

中文使用文档
文档目录11 节
  1. 文档
  2. 开始
  3. 所需资源
  4. 安装
  5. 配置 SDK
  6. 使用独立组件
  7. API 参考
  8. 反馈
  9. 捐款
  10. 提出问题
  11. 脆弱性报告

Helper library for handling JWTs in Angular applications

Release codecov Downloads License CircleCI

:书: 文档 - 摇滚: 开始 - 电脑: API 参考 - 弹道: 反馈

文档

  • 实例 - 普通角-jwt认证情景的代码样本.
  • 文档网站 - 探索我们的文件网站 了解更多关于Auth0.

这个图书馆提供 HttpInterceptor 自动附加 JSON 网络键 改为 HttpClient 请求.

这个库没有任何功能(或关于)执行用户认证和检索JWTs的功能。 这些细节会因您的设置而有所不同, 但在大多数情况下, 您会使用一个常规的 HTTP 请求来认证您的用户, 然后保存他们的 JWT 在本地存储中或如果成功的话在饼干中 .

开始

所需资源

此项目仅支持 积极支持Angular文档中描述的Angular版本。虽然其他版本可能兼容,但它们没有得到积极支持

安装

# installation with npm
npm install @auth0/angular-jwt

# installation with yarn
yarn add @auth0/angular-jwt

配置 SDK

导入 JwtModule 模块并添加到导入列表中。 打电话 forRoot 方法和提供a tokenGetter 函数。 您还必须在 allowedDomains,您想要通过指定 allowedDomains 阵列.

请务必导入 HttpClientModule 还有.

import { JwtModule } from "@auth0/angular-jwt";
import { HttpClientModule } from "@angular/common/http";

export function tokenGetter() {
  return localStorage.getItem("access_token");
}

@NgModule({
  bootstrap: [AppComponent],
  imports: [
    // ...
    HttpClientModule,
    JwtModule.forRoot({
      config: {
        tokenGetter: tokenGetter,
        allowedDomains: ["example.com"],
        disallowedRoutes: ["http://example.com/examplebadroute/"],
      },
    }),
  ],
})
export class AppModule {}

使用Angular 发送的任何请求 HttpClient 自动将一个符号作为 Authorization 头曰.

import { HttpClient } from "@angular/common/http";

export class AppComponent {
  constructor(public http: HttpClient) {}

  ping() {
    this.http.get("http://example.com/api/things").subscribe(
      (data) => console.log(data),
      (err) => console.log(err)
    );
  }
}

使用独立组件

使用时 bootstrapApplication 要使用独立组件拖曳您的应用程序, 您需要一个稍有不同的方式整合我们的 SDK :

import { JwtModule } from "@auth0/angular-jwt";
import { provideHttpClient, withInterceptorsFromDi } from "@angular/common/http";

export function tokenGetter() {
  return localStorage.getItem("access_token");
}

bootstrapApplication(AppComponent, {
    providers: [
        // ...
        importProvidersFrom(
            JwtModule.forRoot({
                config: {
                    tokenGetter: tokenGetter,
                    allowedDomains: ["example.com"],
                    disallowedRoutes: ["http://example.com/examplebadroute/"],
                },
            }),
        ),
        provideHttpClient(
            withInterceptorsFromDi()
        ),
    ],
});

如你所见,不同的是:

  • SDK的模块包括了槽 importProvidersFrom。 。 。 .
  • 为了使用SDK的拦截器, provideHttpClient 需要调用 withInterceptorsFromDi。 。 。 .

API 参考

读取 我们的 API 引用 来更好地了解如何使用这个SDK.

反馈

捐款

我们赞赏反馈和对这次再投资的贡献! 在开始前,请参看以下内容:

提出问题

请提供反馈或报告错误 提出我们的问题追踪器。 。 。 .

脆弱性报告

请不要在公共 GitHub 问题跟踪器上报告安全漏洞 。 这个 负责任的披露程序 详细说明披露安全问题的程序.


Auth0 Logo

Auth0是一个易于执行,可适应的认证和授权平台. 学习更多退房 为什么是Auth0?

这个项目根据麻省理工学院的许可证获得许可。 见 自由主义 需要更多信息的文件.

版本与发布记录

@auth0/angular-jwt 共发布 32 个版本,首次发布于 2017/07/20;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
5.2.0latest2023/10/313 年前
5.1.22022/12/213 年前
5.1.12022/12/153 年前
5.1.02022/10/044 年前
5.0.22020/11/195 年前
5.0.12020/07/076 年前

其他发布通道:beta → 1.0.0-beta.11。

关于 @auth0/angular-jwt 的常见问题

@auth0/angular-jwt 是什么?

用于 Angular 的 JSON Web Token 助手库

如何安装 @auth0/angular-jwt?

在项目目录运行 npm install @auth0/angular-jwt,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@angular/common(>=14.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@auth0/angular-jwt 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@auth0/angular-jwt 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@auth0/angular-jwt 可以商用吗?

@auth0/angular-jwt 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@auth0/angular-jwt 的下载量有多少?

根据 npm 官方下载统计,@auth0/angular-jwt 在 2026/10/07 – 2026/11/05 这 30 天内被下载 1,344,380 次,日均约 44,813 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@auth0/angular-jwt 还在维护吗?

最新版本 5.2.0 发布于 2023/10/31(3 年前);至今共发布 32 个版本,其中过去 12 个月发布了 0 个;首次发布于 2017/07/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。