图床工具的实现-基础篇

图床工具的实现-基础篇

在上一章,我们介绍了图床工具(上传组件)的使用,这一章,我们来解析图床工具的实现,手把手教你写一个图床工具(Node 小工具)。

在教学开始前,我们需要准备:

我们希望你掌握以下知识:

(以下知识也可以跳过,直接开始学习本教程;掌握是为了更好的理解)

我们的基本目标

  • 对基本的文件格式进行限制;
  • 可指定上传目录,完成本地目录与远程目录映射;
  • 图片上传功能;

我们的进阶目标:

  • 将上传组件解耦,做成可配置项;
  • 将上传组件制作成图床工具,将配置与组件解耦,由外部实现调用;
  • 提供 windows 与 mac 双平台的脚本,使非技术人员可以通过该脚本配置公司静态资源;(如 banner 图、广告图)

(以下代码实现保存在 插件合集 中的 demo 目录下)

基本目标

我们的第一个目标是可指定上传目录,完成本地目录与远程目录映射,我们需要完成这个目标的话,我们需要有一个本地目录,所以我们在根目录下新建一个本地目录,取名为 images,我们再预设置一些目录及图片文件,具体如下

图片目录

现在我们的目标是要将本地目录的图片文件上传至远程目录,我们假设本地目录地址为 local_url,远程目录为 remote_url, 那么本地目录文件就是 local_url/images/blogs/plugins/upload/1.png,我们需要将该目录上传到远程目录的 remote_url/images/blogs/plugins/upload/1.png

所以我们第一步就是需要解析本地目录,并且将本地目录的图片文件都解析出来。

我们新建 src/upload/index.js,先定义支持的图片格式

const DEFAULT_ALLOW_FILE = ["png", "jpg"];

定义好了支持的图片格式后,我们开始对目录进行检索

// fs 模块,用于读取目录与文件
const fs = require('fs');
// path 模块,用于解析和拼装路径
const path = require('path');

const DEFAULT_ALLOW_FILE = ["png", "jpg"];

/**
 * 读取目录下的图片文件,收集在 images 中
 * @param {*} entry 入口
 * @param {*} images 图片集合
 */
function readDir(entry, images = []) {
  const dirInfo = fs.readdirSync(entry);
  for (let i = 0; i < dirInfo.length; i++) {
    const item = dirInfo[i];
    // 拼装出文件/文件夹的路径
    const location = path.join(entry, item);
    const isDir = fs.statSync(location).isDirectory();
    // 如果为文件夹则继续递归向下查询
    if (isDir) {
      readDir(location, images);
      // 判断是否为所允许的图片格式
    } else if (DEFAULT_ALLOW_FILE.some(allowScheme => location.endsWith(allowScheme))) {
      images.push(location);
    }
  }
  return images;
}

// 定义检索的入口文件夹( images 文件夹)
const staticDirPath = path.join(__dirname, '../..', 'images');
const images = readDir(staticDirPath);
console.log(images);

我们使用 node src/upload/index.js 命令执行该脚本,最后检索出来的 images 是个数组,包含了本地 images 下所有的图片文件路径,也就是我们需要的 local_url/image_path 集合。

现在我们开始最后一步,开始上传,阿里云 oss 提供了一个库 —— ali-oss,我们使用 npm 进行安装,然后我们在头部导入

const OSS = require("ali-oss");

然后我们根据阿里云提供的 API,编写上传的代码

//...
// Convert Windows backslash paths to slash paths
const slash = require('slash');
const OSS = require("ali-oss");

//...
// 这些配置参数在上一章已经进行说明,不再复述
const client = new OSS({
  "region": "<your config>",
  "accessKeyId": "<your config>",
  "accessKeySecret": "<your config>",
  "bucket": "<your config>",
});

async function upload() {
  for (let i = 0; i < images.length; i++) {
    // slash 是为了兼容 windows 平台的路径划分符为 \ 的特性
    const local_url = slash(images[i]);
    // 阿里云 OSS 目标文件名
    // local_url.split() 是为了去除本地目录的前缀
    const remote_url = `images${local_url.split(staticDirPath)[1]}`;
    // 按顺序依次上传文件
    const result = await client.put(remote_url, local_url)
    console.log(`${result.url} 上传成功`);
  }
  console.log("所有文件上传成功");
}

upload();

我们使用 node src/upload/index.js 命令执行该脚本,下面可以看到执行结果(我的目录与教学的目录不同,所以执行的命令也不一致,可到该地址查看 我的源码

上传成功

至此,我们基本目标已经实现,进阶目标希望是由读者亲自完成,也算是对 Node 的一个练习巩固。

喜欢的话给一颗 star 吧(图床上传工具博文均属于原创)。

Star 超过 5 颗我将马上尽快更新进阶篇,教你如何解耦组件,创建一个非技术人员也能使用的图床工具。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容

  • # 一、框架概述 # 课程概述 1. laravel 4天(之前TP框架还是很大的区别)(国外框架) 2. 在线教...
    关进一阅读 364评论 0 0
  • 图床工具(上传组件)的使用 介绍 我们一般都会有写博客的想法,写博客的话最好是需要图文结合的,而 markdown...
    昵称不用太拉风阅读 1,060评论 1 1
  • 早上起来,隔壁的镇子就乱哄哄的,小钥匙却没有心思打听到底有什么新鲜事儿,因为,她的猫咪已经不见了一整天,她找遍了家...
    半夏水玉阅读 74评论 0 0
  • 陟彼南山,言采其鬟。 拂衣东渡,悠悠锦纶。 鸡鸣中麓,朔雪边关。 须臾相见,日与静还。 行游举乐,济世欢颜。 芳时...
    摩羯星一号阅读 612评论 3 8
  • 人生天地之间,山川是永恒的,江河是永恒的,日月星辰是永恒的。 唯有人的生命是短暂的,就如那昙花一现...
    Hi二哥阅读 325评论 1 4