Node.js+Express.js+TS实现简单图床脚本

更新时间：2023年10月16日 10:09:53 作者：泯泷

在这篇博客文章中,我将介绍如何使用 TypeScript 和 Express 框架来编写一个简单的图床脚本,可以将本地图片上传到服务器,并返回图片的 URL,这样,你就可以在 Markdown 文档中方便地引用图片,而不用担心图片的存储和管理问题

代码实现

我将最新源码放在了MoMeak9/img-service: 简单图床脚本，但是这个是最终版本，添加了很多新的在后续文章才提到的功能，而本文的完整代码我放在了文末，请客官自行取用。

首先，我们需要安装一些依赖包，包括 express、multer 和 dotenv。express 是一个流行的 Node.js Web 框架，提供了基本的路由和中间件功能。multer 是一个用于处理 multipart/form-data 类型的请求体的中间件，可以方便地获取上传的文件。fs 是 Node.js 的内置模块，用于操作文件系统。path 也是 Node.js 的内置模块，用于处理文件路径。dotenv 是一个用于加载环境变量的模块，可以让我们将一些敏感或配置信息存放在 .env 文件中，而不用暴露在代码里。

我们可以使用 npm 或 yarn 来安装这些依赖包：

npm install express multer fs path dotenv
# or
yarn add express multer fs path dotenv

然后，我们需要在项目根目录下创建一个 .env 文件，用来存放一些配置信息，比如服务器端口号、图片存储路径和访问域名等。例如：

PORT=8899
BASEURL=https://fs.lwmc.net

接下来，我们需要在项目根目录下创建一个 src 文件夹，用来存放 TypeScript 源码文件。在 src 文件夹下，我们创建一个 index.ts 文件，作为入口文件。在 index.ts 文件中，我们首先需要导入一些模块：

import express, {NextFunction, Request, Response} from 'express';
import multer from 'multer';
import fs from 'fs';
import path from 'path';
import dotenv from 'dotenv';

你也看出来了，我们还需要添加一些类型辅助

npm install @types/express @types/multer @types/node -D
# or
yarn add @types/express @types/multer @types/node -D

跨域配置（上传和静态文件跨域访问能力）

// 允许跨域请求
app.use((req: Request, res: Response, next) => {
    res.header('Access-Control-Allow-Origin', '*');
    res.header('Access-Control-Allow-Methods', 'GET, POST');
    res.header('Access-Control-Allow-Headers', 'Content-Type, Authorization, Content-Length, X-Requested-With');
    next();
});

路由

应该包含有静态资源路由和上传路由：

静态资源路由开放对/uploads路径下资源的访问

// 静态文件路由
app.use('/uploads', express.static(path.resolve(__dirname, '../uploads')));

上传路由开放对/uploadPOST方法的访问：

upload.single('file') 是一个 multer 中间件，表示只允许上传一个文件，并且上传的文件参数名是 'file'。
(req: Request, res: Response) => { ... } 是路由处理函数，当客户端向 '/upload' 路径发送 POST 请求时，会执行这个函数。
const file = req.file; 表示从请求中获取上传的文件。
if (!file) { ... } 表示如果没有上传文件，返回一个 400 错误响应。
res.send({ ... }) 表示向客户端发送一个 JSON 响应，包含上传文件的信息，包括文件名、原始文件名、文件类型、文件大小和文件的访问路径。其中文件访问路径是通过拼接服务器地址和文件路径得到的。

// 上传文件路由
app.post('/upload', upload.single('file'), (req: Request, res: Response) => {
    const file = req.file;
    if (!file) {
        res.status(400).send('Please upload a file.');
        return;
    }
    
    // 返回文件信息
    res.send({
        filename: file.filename,
        originalname: file.originalname,
        mimetype: file.mimetype,
        size: file.size,
        path: `http://localhost:3000/${commonPath}/${file.filename}`,
    });
    // 复原公共路径
    commonPath = 'uploads/'
});

multer 配置

代码使用了 multer 中间件来处理上传文件的请求。Multer 是一个 node.js 中间件，用于处理文件上传，支持多文件上传，可以设置文件大小、文件类型和保存路径等。

以下是对代码配置项的解释：

dest 属性指定上传文件的保存目录，这里设置为 'uploads/' 目录下。如果目录不存在，则会自动创建。
limits 属性设置上传文件的限制，这里限制文件大小为 10MB。
fileFilter 属性指定上传文件的类型，这里限制只能上传 image/png、image/jpeg、image/gif、image/webp、image/svg+xml 这些类型的文件。如果文件类型不在指定的类型列表中，则会触发错误。
storage 属性指定上传文件的存储方式，这里使用了 diskStorage 存储方式。在存储文件时，会根据上传时间按年月日来创建文件夹，并将文件存储在对应的文件夹下。
filename 方法指定上传文件的命名规则，这里使用时间戳加原始文件名的方式来命名文件。

// 上传文件的中间件
const upload = multer({
    dest: 'uploads/',
    limits: {
        fileSize: 1024 * 1024 * 10, // 限制文件大小为10M
    },
    fileFilter: (req, file, cb) => {
        // 限制文件类型
        const allowedTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/webp', 'image/svg+xml'];
        if (!allowedTypes.includes(file.mimetype)) {
            cb(new Error('Invalid file type.'));
            return;
        }
        cb(null, true);
    },
    storage: multer.diskStorage({
        destination: (req, file, cb) => {
            if (!fs.existsSync('uploads/')) {
                fs.mkdirSync('uploads/');
            }
            // 获取日期
            const date = new Date();
            const year = date.getFullYear();
            const month = date.getMonth() + 1;
            const day = date.getDate();
            commonPath = path.join(commonPath, year.toString());
            if (!fs.existsSync(path.join(commonPath))) {
                fs.mkdirSync(path.join(commonPath));
            }
            commonPath = path.join(commonPath, month.toString().padStart(2, '0'));
            if (!fs.existsSync(path.join(commonPath))) {
                fs.mkdirSync(path.join(commonPath));
            }
            // 拼接路径
            cb(null, commonPath);
        },
        filename: (req, file, cb) => {
            cb(null, `${Date.now()}${file.originalname}`);
        },
    }),
});

完整代码：

import express, {Request, Response} from 'express';
import multer from 'multer';
import fs from 'fs';
import path from 'path';
const app = express();
// 公共路径
let commonPath = 'uploads/';
// 上传文件的中间件
const upload = multer({
    dest: 'uploads/',
    limits: {
        fileSize: 1024 * 1024 * 10, // 限制文件大小为10M
    },
    fileFilter: (req, file, cb) => {
        // 限制文件类型
        const allowedTypes = ['image/png', 'image/jpeg', 'image/gif', 'image/webp', 'image/svg+xml'];
        if (!allowedTypes.includes(file.mimetype)) {
            cb(new Error('Invalid file type.'));
            return;
        }
        cb(null, true);
    },
    storage: multer.diskStorage({
        destination: (req, file, cb) => {
            if (!fs.existsSync('uploads/')) {
                fs.mkdirSync('uploads/');
            }
            // 获取日期
            const date = new Date();
            const year = date.getFullYear();
            const month = date.getMonth() + 1;
            const day = date.getDate();
            commonPath = path.join(commonPath, year.toString());
            if (!fs.existsSync(path.join(commonPath))) {
                fs.mkdirSync(path.join(commonPath));
            }
            commonPath = path.join(commonPath, month.toString().padStart(2, '0'));
            if (!fs.existsSync(path.join(commonPath))) {
                fs.mkdirSync(path.join(commonPath));
            }
            // 拼接路径
            cb(null, commonPath);
        },
        filename: (req, file, cb) => {
            cb(null, `${Date.now()}${file.originalname}`);
        },
    }),
});
// 允许跨域请求
app.use((req: Request, res: Response, next) => {
    res.header('Access-Control-Allow-Origin', '*');
    res.header('Access-Control-Allow-Methods', 'GET, POST');
    res.header('Access-Control-Allow-Headers', 'Content-Type, Authorization, Content-Length, X-Requested-With');
    next();
});
// 静态文件路由
app.use('/uploads', express.static(path.resolve(__dirname, '../uploads')));
// 上传文件路由
app.post('/upload', upload.single('file'), (req: Request, res: Response) => {
    const file = req.file;
    if (!file) {
        res.status(400).send('Please upload a file.');
        return;
    }
    // 返回文件信息
    res.send({
        filename: file.filename,
        originalname: file.originalname,
        mimetype: file.mimetype,
        size: file.size,
        path: `http://localhost:3000/${commonPath}/${file.filename}`,
    });
    commonPath = 'uploads/'
});
// 启动服务器
const port = process.env.PORT || 3000;
app.listen(port, () => {
    console.log(`server started at http://localhost:${port}`);
});

以上就是Node.js+Express.js+TS实现简单图床脚本的详细内容，更多关于Node.js Express.js TS图床脚本的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

使用Node操作MySQL的两种方式
本文将介绍如何在 Node.js 应用中使用 mysql2 和 TypeORM 两种方式操作 MySQL 数据库,文中通过代码示例介绍的非常详细,对大家的学习有一定的帮助,需要的朋友可以参考下
2024-05-05
npm install编译时报"Cannot read properties of null (r
这篇文章主要给大家介绍了关于npm install编译时报“Cannot read properties of null (reading ‘pickAlgorithm‘)“错误的解决办法,文中将解决方法介绍的非常详细,需要的朋友可以参考下
2022-07-07
Nodejs脚本快速导出MySQL数据库数据
在数据库管理和数据迁移的过程中,常常需要将数据库中的表数据和结构进行导出,本文将使用Node.js编写一个脚本实现快速从MySQL数据库中导出所有表的数据和结构,并保存为单独的SQL文件,需要的可以参考下
2024-10-10
koa-passport实现本地验证的方法示例
这篇文章主要介绍了koa-passport实现本地验证的方法示例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-02-02
Node.js实用代码段之获取Buffer对象字节长度
这篇文章主要介绍了Node.js实用代码段之获取Buffer对象字节长度,需要的朋友可以参考下
2016-03-03
nodejs创建简易web服务器与文件读写的实例
下面小编就为大家带来一篇node js系列课程-创建简易web服务器与文件读写的实例。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-09-09
Node.js中使用Log.io在浏览器中实时监控日志（等同tail -f命令）
这篇文章主要介绍了Node.js中使用Log.io在浏览器中实时监控日志,Log.io等同于tail -f命令,但更强大,需要的朋友可以参考下
2014-09-09
node.js学习之base64编码解码
开发者对Base64编码肯定很熟悉，是否对它有很清晰的认识就不一定了。实际上Base64已经简单到不能再简单了，这篇文章给大家通过示例代码介绍了node.js对字符串和图片base64编码解码的方法，有需要的朋友们可以通过本文来进行学习，下面来一起看看吧。
2016-10-10
Node的事件处理和readline模块详解
这篇文章主要为大家详细介绍了Node的事件处理和readline模块，使用数据库，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-02-02
Nodejs为什么选择javascript为载体语言
准备写一个NodeJS方面的系列文章，由浅入深，循序渐进，秉承的理念是重思想，多实践，勤能补拙，贵在坚持。本文首先来点基础知识的开篇吧。
2015-01-01