@kne/fastify-file-manager 0.1.0

package/README.md

@@ -0,0 +1,27 @@
+
+# fastify-file-manager
+
+
+### 描述
+
+用于管理静态文件上传查看等
+
+
+### 安装
+
+```shell
+npm i --save @kne/fastify-file-manager
+```
+
+### 示例
+
+#### 示例代码
+
+
+
+### API
+
+| 属性名 | 说明 | 类型 | 默认值 |
+|-----|----|----|-----|
+|     |    |    |     |
+

package/index.js

@@ -0,0 +1,43 @@
+const fp = require('fastify-plugin');
+const autoload = require('@fastify/autoload');
+const path = require('path');
+const fs = require('fs-extra');
+
+module.exports = fp(
+  async (fastify, options) => {
+    options = Object.assign(
+      {
+        root: path.join(process.cwd(), 'static'),
+        namespace: 'default',
+        prefix: '/static',
+        multipart: {},
+        static: {},
+        authenticateFileRead: async () => {},
+        authenticateFileMange: async () => {},
+        authenticateFileUpload: async () => {}
+      },
+      options
+    );
+    await fs.ensureDir(options.root);
+    await fastify.sequelize.addModels(path.resolve(__dirname, './models'));
+
+    fastify.register(require('@fastify/multipart'), options.multipart);
+    fastify.register(autoload, {
+      dir: path.resolve(__dirname, './libs'),
+      options
+    });
+    fastify.register(
+      require('@fastify/static'),
+      Object.assign({}, options.static, {
+        root: options.root,
+        prefix: options.prefix + '/file/',
+        index: false,
+        list: false
+      })
+    );
+  },
+  {
+    name: 'fastify-file-manager',
+    dependencies: ['fastify-sequelize']
+  }
+);

package/libs/controller.js

@@ -0,0 +1,117 @@
+const fp = require('fastify-plugin');
+
+module.exports = fp(async (fastify, options) => {
+  fastify.post(
+    `${options.prefix}/upload`,
+    {
+      onRequest: [options.authenticateFileUpload]
+    },
+    async request => {
+      const file = await request.file();
+      if (!file) {
+        throw new Error('不能获取到上传文件');
+      }
+      //1. 保存到服务器目录 2.对接oss
+      return await fastify.fileManagerServices.uploadToFileSystem({ file, namespace: options.namespace });
+    }
+  );
+
+  fastify.get(
+    `${options.prefix}/file-url/:id`,
+    {
+      onRequest: [options.authenticateFileRead],
+      schema: {
+        params: {
+          type: 'object',
+          required: ['id'],
+          properties: {
+            id: { type: 'string' }
+          }
+        }
+      }
+    },
+    async request => {
+      const { id } = request.params;
+      return await fastify.fileManagerServices.getFileUrl({ id, namespace: options.namespace });
+    }
+  );
+
+  fastify.get(
+    `${options.prefix}/file-id/:id`,
+    {
+      onRequest: [options.authenticateFileRead],
+      schema: {
+        query: {
+          type: 'object',
+          properties: {
+            attachment: { type: 'boolean' },
+            filename: { type: 'string' }
+          }
+        },
+        params: {
+          type: 'object',
+          required: ['id'],
+          properties: {
+            id: { type: 'string' }
+          }
+        }
+      }
+    },
+    async (request, reply) => {
+      const { id } = request.params;
+      const { attachment, filename: targetFilename } = request.query;
+      const { targetFileName, filename } = await fastify.fileManagerServices.getFileInfo({
+        id,
+        namespace: options.namespace
+      });
+      return attachment ? reply.download(targetFileName, targetFilename || filename) : reply.sendFile(targetFileName);
+    }
+  );
+
+  fastify.get(
+    `${options.prefix}/file-list`,
+    {
+      onRequest: [options.authenticateFileMange],
+      schema: {
+        query: {}
+      }
+    },
+    async request => {
+      const { filter, perPage, currentPage } = Object.assign({}, request.query, {
+        perPage: 20,
+        currentPage: 1
+      });
+      return await fastify.fileManagerServices.getFileList({
+        filter,
+        namespace: options.namespace,
+        perPage,
+        currentPage
+      });
+    }
+  );
+
+  fastify.post(
+    `${options.prefix}/delete-file`,
+    {
+      onRequest: [options.authenticateFileMange],
+      schema: {
+        body: {
+          type: 'object',
+          required: ['id'],
+          properties: {
+            id: { type: 'string' }
+          }
+        }
+      }
+    },
+    async request => {
+      const { id } = request.body;
+      await fastify.fileManagerServices.deleteFile({ id, namespace: options.namespace });
+      return {};
+    }
+  );
+
+  fastify.get(`${options.prefix}`, async () => {
+    return 'living';
+  });
+});

package/libs/service.js

@@ -0,0 +1,83 @@
+const fp = require('fastify-plugin');
+const fs = require('fs-extra');
+const crypto = require('crypto');
+const path = require('path');
+
+module.exports = fp(async (fastify, options) => {
+  const uploadToFileSystem = async ({ file, namespace }) => {
+    const { filename, encoding, mimetype } = file;
+    const buffer = await file.toBuffer();
+    const hash = crypto.createHash('md5');
+    hash.update(buffer);
+    const digest = hash.digest('hex');
+    const extension = path.extname(filename);
+    const filepath = path.resolve(options.root, `${digest}${extension}`);
+    await fs.writeFile(filepath, buffer);
+    console.log({
+      filename,
+      namespace,
+      encoding,
+      mimetype,
+      hash: digest,
+      size: buffer.byteLength
+    });
+    return await fastify.models.fileManager.create({
+      filename,
+      namespace,
+      encoding,
+      mimetype,
+      hash: digest,
+      size: buffer.byteLength
+    });
+  };
+
+  const getFileUrl = async ({ id, namespace }) => {
+    const file = await fastify.models.fileManager.findByPk(id, {
+      where: { namespace }
+    });
+    if (!file) {
+      throw new Error('文件不存在');
+    }
+    const extension = path.extname(file.filename);
+    return `${options.prefix}/file/${file.hash}${extension}?filename=${file.filename}`;
+  };
+
+  const getFileInfo = async ({ id, namespace }) => {
+    const file = await fastify.models.fileManager.findByPk(id, {
+      where: { namespace }
+    });
+    if (!file) {
+      throw new Error('文件不存在');
+    }
+    const extension = path.extname(file.filename);
+    return Object.assign({}, file, {
+      targetFileName: `${file.hash}${extension}`
+    });
+  };
+
+  const getFileList = async ({ filter, namespace, currentPage, perPage }) => {
+    const queryFilter = { namespace };
+    const { count, rows } = await fastify.models.fileManager.findAndCountAll({
+      where: queryFilter,
+      offset: currentPage * (currentPage - 1),
+      limit: perPage
+    });
+    return {
+      pageData: rows,
+      totalCount: count
+    };
+  };
+
+  const deleteFile = async ({ id, namespace }) => {
+    const file = await fastify.models.fileManager.findByPk(id, {
+      where: { namespace }
+    });
+    if (!file) {
+      throw new Error('文件不存在');
+    }
+
+    await file.destroy();
+  };
+
+  fastify.decorate('fileManagerServices', { uploadToFileSystem, getFileUrl, getFileInfo, getFileList, deleteFile });
+});

package/models/file-manager.js

@@ -0,0 +1,23 @@
+module.exports = (sequelize, DataTypes) => {
+  return sequelize.define('fileManager', {
+    id: {
+      type: DataTypes.UUID, defaultValue: DataTypes.UUIDV4, primaryKey: true
+    }, filename: {
+      type: DataTypes.STRING, allowNull: false
+    }, hash: {
+      type: DataTypes.STRING, allowNull: false
+    }, namespace: {
+      type: DataTypes.STRING, defaultValue: 'default'
+    }, size: {
+      type: DataTypes.INTEGER, allowNull: false
+    }, encoding: DataTypes.STRING, mimetype: DataTypes.STRING
+  }, {
+    indexes: [{
+      fields: ['namespace']
+    }, {
+      fields: ['filename']
+    }, {
+      fields: ['hash']
+    }]
+  });
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@kne/fastify-file-manager",
+  "version": "0.1.0",
+  "description": "用于管理静态文件上传查看等",
+  "main": "index.js",
+  "scripts": {
+    "init": "husky",
+    "build:md": "npx @kne/md-doc",
+    "start:md": "npx @kne/md-doc --watch",
+    "prettier": "prettier --config .prettierrc --write '{libs/**/*,index}.{js,jsx,ts,tsx,json,css,scss}'",
+    "lint-staged": "npx lint-staged"
+  },
+  "lint-staged": {
+    "{libs/**/*,index}.{js,jsx,ts,tsx,json,css,scss}": [
+      "prettier --config .prettierrc --write",
+      "git add"
+    ]
+  },
+  "files": [
+    "index.js",
+    "libs",
+    "models"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kne-union/fastify-file-manager.git"
+  },
+  "keywords": [],
+  "author": "linzp",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/kne-union/fastify-file-manager/issues"
+  },
+  "homepage": "https://github.com/kne-union/fastify-file-manager#readme",
+  "devDependencies": {
+    "@kne/fastify-sequelize": "^0.1.3",
+    "fastify": "^4.27.0",
+    "husky": "^9.0.11",
+    "prettier": "^3.2.5",
+    "sqlite3": "^5.1.7"
+  },
+  "dependencies": {
+    "@fastify/autoload": "^5.8.2",
+    "@fastify/multipart": "^8.2.0",
+    "@fastify/static": "^7.0.4",
+    "fastify-plugin": "^4.5.1",
+    "fs-extra": "^11.2.0"
+  }
+}