下面是一个示例代码,展示了如何编写一个自定义的Mongoose插件来返回签名的S3 URL。
首先,需要安装依赖项:
npm install aws-sdk
然后,创建一个名为mongoose-s3-url-plugin.js
的文件,并将以下代码添加到文件中:
const AWS = require('aws-sdk');
const { Schema } = require('mongoose');
// 创建一个函数来生成签名的S3 URL
function generateSignedS3Url(key) {
const s3 = new AWS.S3();
const params = {
Bucket: 'your-bucket-name',
Key: key,
Expires: 60 // URL有效期为60秒
};
return new Promise((resolve, reject) => {
s3.getSignedUrl('getObject', params, (error, url) => {
if (error) {
reject(error);
} else {
resolve(url);
}
});
});
}
// 创建插件函数
function s3UrlPlugin(schema, options) {
// 添加一个虚拟属性来返回签名的S3 URL
schema.virtual('signedS3Url').get(function () {
const key = this.get(options.fieldName);
if (!key) {
return null;
}
return generateSignedS3Url(key);
});
}
module.exports = s3UrlPlugin;
在上面的代码中,我们首先导入所需的依赖项,包括aws-sdk
和mongoose
的Schema
模块。然后,我们定义了一个函数generateSignedS3Url
来生成签名的S3 URL。这个函数使用AWS SDK创建一个S3实例,并使用getSignedUrl
方法生成签名的URL。URL将在60秒后过期。
接下来,我们定义了一个名为s3UrlPlugin
的插件函数。这个函数接受一个schema
和一个可选的options
对象作为参数。在插件函数中,我们添加一个虚拟属性signedS3Url
到schema
中。这个属性的getter函数将获取指定options.fieldName
字段的值,并调用generateSignedS3Url
函数来生成签名的S3 URL。
最后,我们将插件函数导出,以便在Mongoose模型中使用。
在使用插件的Mongoose模型中,需要首先导入插件,并将其作为参数传递给模式的plugin
方法:
const mongoose = require('mongoose');
const s3UrlPlugin = require('./mongoose-s3-url-plugin');
const schema = new mongoose.Schema({
// 添加其他字段
imageKey: String
});
// 使用插件
schema.plugin(s3UrlPlugin, { fieldName: 'imageKey' });
const Model = mongoose.model('Model', schema);
module.exports = Model;
在上面的代码中,我们首先导入Mongoose和我们刚刚创建的插件。然后,我们创建一个包含其他字段的模式。在调用plugin
方法时,将插件函数和一个配置对象传递给它。在这个例子中,我们将fieldName
设置为与模型中存储S3键的字段名称相匹配。
最后,我们创建一个模型并将其导出,以便在其他地方使用。
使用这个自定义的插件,您可以在Mongoose模型实例上访问signedS3Url
属性来获取签名的S3 URL,如下所示:
const Model = require('./your-model');
const instance = new Model();
const url = instance.signedS3Url;
console.log(url);
请注意,您需要将your-bucket-name
替换为您的实际S3存储桶名称。另外,请确保在使用插件之前配置您的AWS凭证。您可以通过环境变量、共享凭证文件或其他方式来配置这些凭证。