Skip to main content

如何从 Strapi 插件存储和访问数据

¥How to store and access data from a Strapi plugin

🏗 正在进行的工作

此页面的内容可能尚未与 Strapi 5 完全同步。

¥The content of this page might not be fully up-to-date with Strapi 5 yet.

要使用 Strapi plugin 存储数据，请使用插件内容类型。插件内容类型的工作方式与其他 content-types 完全相同。一旦内容类型为 created，你就可以启动 与数据交互。

¥To store data with a Strapi plugin, use a plugin content-type. Plugin content-types work exactly like other content-types. Once the content-type is created, you can start interacting with the data.

为你的插件创建内容类型​

¥Create a content-type for your plugin

要使用 CLI 生成器创建内容类型，请在终端中运行以下命令：

¥To create a content-type with the CLI generator, run the following command in a terminal:

yarn strapi generate content-type

生成器 CLI 是交互式的，会询问一些有关内容类型及其包含的属性的问题。回答第一个问题，然后对于 Where do you want to add this model? 问题，选择 Add model to existing plugin 选项并在询问时输入相关插件的名称。

¥The generator CLI is interactive and asks a few questions about the content-type and the attributes it will contain. Answer the first questions, then for the Where do you want to add this model? question, choose the Add model to existing plugin option and type the name of the related plugin when asked.

Generating a content-type plugin with the CLI
The strapi generate content-type CLI generator is used to create a basic content-type for a plugin.

CLI 将生成一些使用你的插件所需的代码，其中包括以下内容：

¥The CLI will generate some code required to use your plugin, which includes the following:

💡 提示

你可能希望完全使用 CLI 生成器或直接创建和编辑 schema.json 文件来创建内容类型的整个结构。我们建议你首先使用 CLI 生成器创建一个简单的内容类型，然后利用管理面板中的 内容类型生成器 来编辑你的内容类型。

¥You may want to create the whole structure of your content-types either entirely with the CLI generator or by directly creating and editing schema.json files. We recommend you first create a simple content-type with the CLI generator and then leverage the Content-Type Builder in the admin panel to edit your content-type.

如果你的内容类型在管理面板中不可见，你可能需要在内容类型架构的 pluginOptions 对象中将 content-manager.visible 和 content-type-builder.visible 参数设置为 true：

¥If your content-type is not visible in the admin panel, you might need to set the content-manager.visible and content-type-builder.visible parameters to true in the pluginOptions object of the content-type schema:

Making a plugin content-type visible in the admin panel:

示例 schema.json 文件中的以下高亮的行显示了如何使插件内容类型对内容类型生成器和内容管理器可见：

¥The following highlighted lines in an example schema.json file show how to make a plugin content-type visible to the Content-Type Builder and Content-Manager:

/server/content-types/my-plugin-content-type/schema.json
{
  "kind": "collectionType",
  "collectionName": "my_plugin_content_types",
  "info": {
    "singularName": "my-plugin-content-type",
    "pluralName": "my-plugin-content-types",
    "displayName": "My Plugin Content-Type"
  },
  "options": {
    "draftAndPublish": false,
    "comment": ""
  },
  "pluginOptions": {
    "content-manager": {
      "visible": true
    },
    "content-type-builder": {
      "visible": true
    }
  },
  "attributes": {
    "name": {
      "type": "string"
    }
  }
}

确保导入插件内容类型​

¥Ensure plugin content-types are imported

CLI 生成器可能尚未导入插件的所有相关内容类型文件，因此你可能需要在 strapi generate content-type CLI 命令完成运行后进行以下调整：

¥The CLI generator might not have imported all the related content-type files for your plugin, so you might have to make the following adjustments after the strapi generate content-type CLI command has finished running:

  1. 在 /server/index.js 文件中，导入内容类型：

    ¥In the /server/index.js file, import the content-types:

/server/index.js
'use strict';

const register = require('./register');
const bootstrap = require('./bootstrap');
const destroy = require('./destroy');
const config = require('./config');
const contentTypes = require('./content-types');
const controllers = require('./controllers');
const routes = require('./routes');
const middlewares = require('./middlewares');
const policies = require('./policies');
const services = require('./services');

module.exports = {
  register,
  bootstrap,
  destroy,
  config,
  controllers,
  routes,
  services,
  contentTypes,
  policies,
  middlewares,
};

  1. 在 /server/content-types/index.js 文件中，导入内容类型文件夹：

    ¥In the /server/content-types/index.js file, import the content-type folder:

/server/content-types/index.js
'use strict';

module.exports = {
  // In the line below, replace my-plugin-content-type
  // with the actual name and folder path of your content type
  "my-plugin-content-type": require('./my-plugin-content-type'),
};

  1. 确保 /server/content-types/[your-content-type-name] 文件夹不仅包含 CLI 生成的 schema.json 文件，还包含导出内容类型的 index.js 文件，代码如下：

    ¥Ensure that the /server/content-types/[your-content-type-name] folder contains not only the schema.json file generated by the CLI, but also an index.js file that exports the content-type with the following code:

"/server/content-types/my-plugin-content-type/index.js
'use strict';

const schema = require('./schema');

module.exports = {
  schema,
};

与插件中的数据交互​

¥Interact with data from the plugin

为插件创建内容类型后，你可以创建、读取、更新和删除数据。

¥Once you have created a content-type for your plugin, you can create, read, update, and delete data.

✏️ 注意

插件只能与 /server 文件夹中的数据交互。如果你需要从管理面板更新数据，请参阅 传递数据指南。

¥A plugin can only interact with data from the /server folder. If you need to update data from the admin panel, please refer to the passing data guide.

要创建、读取、更新和删除数据，你可以使用 实体服务 API 或 查询引擎 API。虽然建议使用实体服务 API，特别是当你需要访问组件或动态区域时，但如果你需要不受限制地访问底层数据库，则查询引擎 API 会很有用。

¥To create, read, update, and delete data, you can use either the Entity Service API or the Query Engine API. While it's recommended to use the Entity Service API, especially if you need access to components or dynamic zones, the Query Engine API is useful if you need unrestricted access to the underlying database.

在实体服务和查询引擎 API 查询中使用 plugin::your-plugin-slug.the-plugin-content-type-name 语法作为内容类型标识符。

¥Use the plugin::your-plugin-slug.the-plugin-content-type-name syntax for content-type identifiers in Entity Service and Query Engine API queries.

示例：

¥Example:

以下是如何查找为名为 my-plugin 的插件创建的 my-plugin-content-type 集合类型的所有条目：

¥Here is how to find all the entries for the my-plugin-content-type collection type created for a plugin called my-plugin:

// Using the Entity Service API
let data = await strapi.entityService.findMany('plugin::my-plugin.my-plugin-content-type');

// Using the Query Engine API
let data = await strapi.db.query('plugin::my-plugin.my-plugin-content-type').findMany();
💡 提示

你可以通过 strapi 对象访问数据库，该对象可以在 middlewares、policies、controllers、services 以及 register、boostrap、destroy 生命周期函数中找到。

¥You can access the database via the strapi object which can be found in middlewares, policies, controllers, services, as well as from the register, boostrap, destroy lifecycle functions.