# @eggjs/jsonp 中文文档

规范地址：https://npmcn.com/package/%40eggjs/jsonp/

版本：4\.1\.0
npm 元数据更新时间：2026-10-07T08:18:36.657Z
中文译文更新时间：2026-11-13T09:45:52.888Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40eggjs/jsonp
原文对照：https://npmcn.com/package/%40eggjs/jsonp/?lang=original
项目主页：https://github.com/eggjs/egg/tree/next/plugins/jsonp
源码仓库：https://github.com/eggjs/egg

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：14 kB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：1 个
- peer 依赖：egg 4\.2\.0
- 首次发布：2025-01-11T10:41:21.315Z
- 最新版本发布：2026-10-07T08:18:35.797Z
- 近 30 天下载量：5060（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：53（近 12 个月 33 个）

## 中文简介

jsonp 支持鸡蛋

## 安装

```sh
npm install @eggjs/jsonp
```

也可以使用：`pnpm add @eggjs/jsonp`、`yarn add @eggjs/jsonp`、`bun add @eggjs/jsonp`

## README

# 翻译:

[![NPM version](https://img.shields.io/npm/v/@eggjs/jsonp.svg?style=flat-square)](https://npmjs.org/package/@eggjs/jsonp) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/jsonp/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/jsonp) [![npm download](https://img.shields.io/npm/dm/@eggjs/jsonp.svg?style=flat-square)](https://npmjs.org/package/@eggjs/jsonp) [![Node.js Version](https://img.shields.io/node/v/@eggjs/jsonp.svg?style=flat)](https://nodejs.org/en/download/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com/)

Jsonp 支持的鸡蛋插件 .

## 使用量

彩蛋内置插件 `jsonp` 默认启用.

```ts
// {app_root}/config/plugin.ts

export default {
  jsonp: {
    enable: true,
  },
};
```

## 配置

-   {String{Array} 回调 - jsonp 回调方法密钥,默认为 `[ '_callback', 'callback' ]`
-   {编号} 限制 - 回调方法名称的最大长度, 默认为 `50`
-   csrf - 允许csrf检查与否. 默认为虚假
-   {String}RegExp{Array} 白名单 - 裁判员白名单

若为白色 列表类型是 `RegExp`,裁判员必须匹配 `whiteList`,注意第一个 `^` 最后一个 `/`。 。 。 .

```ts
export default {
  jsonp: {
    whiteList: /^https?:\/\/test.com\//,
  },
};

// matchs referrer:
// https://test.com/hello
// http://test.com/
```

若为白色 列表类型是 `String` 开始 `.`数字 :

```ts
export default {
  jsonp: {
    whiteList: '.test.com',
  },
};

// matchs domain test.com:
// https://test.com/hello
// http://test.com/

// matchs subdomain
// https://sub.test.com/hello
// http://sub.sub.test.com/
```

若为白色 列表类型是 `String` 而不是从 `.`数字 :

```ts
export default {
  jsonp: {
    whiteList: 'sub.test.com',
  },
};

// only matchs domain sub.test.com:
// https://sub.test.com/hello
// http://sub.test.com/
```

白色列表也可以是一个阵列:

```ts
export default {
  jsonp: {
    whiteList: ['.foo.com', '.bar.com'],
  },
};
```

见 [配置/ 配置. 默认. ts](https://github.com/eggjs/egg/blob/master/plugins/jsonp/src/config/config.default.ts) 更详细.

## API 密码

-   ctx.acceptJSONP (中文(简体) ). - 检测答复是否为jsonp,只读

## 示例

### 标准应用程序使用

单位 `app/router.ts`

```ts
// Create once and use in any router you want to support jsonp.
const jsonp = app.jsonp();

app.get('/default', jsonp, 'jsonp.index');
app.get('/another', jsonp, 'jsonp.another');

// Customize by create another jsonp middleware with specific configurations.
app.get('/customize', app.jsonp({ callback: 'fn' }), 'jsonp.customize');
```

### teg Http 控制器使用量

TOD: TBD 数据

## 问题和建议

请打开一个问题 [这里](https://github.com/eggjs/egg/issues)。 。 。 .

## 许可证

[麻省理工学院](https://npmcn.com/package/%40eggjs/jsonp/LICENSE)

## 贡献者

[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)

制造的 [贡献者-img](https://contrib.rocks/)。 。 。 .

## 常见问题

### @eggjs/jsonp 是什么？

jsonp 支持鸡蛋

### 如何安装 @eggjs/jsonp？

在项目目录运行 npm install @eggjs/jsonp，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：egg（4\.2\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @eggjs/jsonp 支持 TypeScript 吗？

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

### @eggjs/jsonp 支持 ESM 还是 CommonJS？

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

### @eggjs/jsonp 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.18\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @eggjs/jsonp 可以商用吗？

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

### @eggjs/jsonp 的下载量有多少？

根据 npm 官方下载统计，@eggjs/jsonp 在 2026/10/13 – 2026/11/11 这 30 天内被下载 5,060 次，日均约 169 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @eggjs/jsonp 还在维护吗？

最新版本 4\.1\.0 发布于 2026/10/07（1 个月前）；至今共发布 53 个版本，其中过去 12 个月发布了 33 个；首次发布于 2025/01/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。