node.js使用express-fileupload中介軟體實現檔案上傳

2021-07-16 19:01:15

本文使用express作為伺服器端，使用express-fileupload庫提供的中介軟體函數來接受從使用者端傳來的圖片，並將圖片作為檔案儲存在伺服器端。使用者端使用create-react-app框架，bootstrap UI，axios傳送http請求和提供進度條當前進度的值，上傳成功後，根據圖片在伺服器端上的位置，並顯示圖片。

初始化專案

mkdir react-file-upload    // 建立專案根目錄
cd react-file-upload
npm init -y                // 初始化 npm 建立 package.json

安裝一些必要依賴(dependencies)

npm i express express-fileupload
npm i -D nodemon concurrently    // 可以並行同時執行使用者端和伺服器端(在本機進行測試)

更改 react-file-upload/package.json 中的 scripts 指令碼

{
  "main": "server.js",
  "script" : {
    "start": "node server.js", 
    "server": "nodemon server.js",
    "client": "npm start --prefix client",  
    "dev": " concurrently "npm run server" "npm run client" "
  }
}

main 改為 server.js
start 使用 node 啟動 express
server 使用 nodemon 啟動 express ，nodemon會監視server.js檔案是否有變動 (ctrl+S) 若有變動重新啟動伺服器而node啟動則不會，需要手動重啟服務(ctrl+C 且改動檔案後重新執行 node server.js)
client 啟動使用者端隨後我們會建立 client 資料夾編寫 react 元件
dev 使用 concurrently 同時啟動伺服器端與使用者端

編寫伺服器

下面來編寫 server.js 檔案

const express = require('express');
const fileUpload = require('express-fileupload');

const app = express();
// 使用 express-fileupload 中介軟體
app.use( fileUpload() );

// 處理由 /upload 頁面傳送過來的post請求
app.post('/upload', (req, res) => {
  // req 中的 files 屬性由 express-fileupload 中介軟體新增!? (疑問暫存)
  // 判斷 files 屬性是否存在 和 是否有檔案傳來 若無返回400
  if(req.files === null){
    return res.status(400).json({msg:'no file uploaded'});
  }
  // 否則 獲取檔案
  // file 由後文中 formData.append('file', file) 的第一個引數定義 可自定義為其他名稱
  const file = req.files.file;
  // 移動檔案到第一引數指定位置 若有錯誤 返回500
  file.mv(`${__dirname}/client/public/uploads/${file.name}`, err => {
    if(err){
      console.error(err);
      return res.status(500).send(err);
    }
    // 若無錯誤 返回一個 json 
    // 我們計劃上傳檔案後 根據檔案在伺服器上的路徑 顯示上傳後的檔案
    // 隨後我們會在 react 元件中實現
    // 在使用者端中的 public 資料夾下建立 uploads 資料夾 用於儲存上傳的檔案
    res.json({fileName: file.name, filePath: `uploads/${file.name}`});
  });
});

app.listen(5000,() => {console.log('Server started...')});

現在執行一遍 server.js 保證無錯誤會在控制檯看到 Server started...

npm run server

初始化使用者端

然後我們建立使用者端我們使用 create-react-app 腳手架初始化專案

npx create-react-app client

初始化完成後我們可以先選擇性的刪除一些不必要的檔案

serviceWorker.js
logo.svg
index.css // 之後我們會用link標籤從cdn引入bootstrap的
App.test.js // 只是個小demo

我們刪除 src / index.js 檔案中引入的 index.css，在 public 資料夾中的 index.html 模板檔案中，直接引入bootstrap 的 css 和 js

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico" rel="external nofollow"  />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <meta name="theme-color" content="#000000" />
    <!-- 引入css -->
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="external nofollow"  integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" rel="external nofollow"  />
    <title>React File Uploader</title>
  </head>
  <body>
    <noscript>You need to enable JavaScript to run this app.</noscript>
    <div id="root"></div>
    <!-- 引入js -->
    <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
  </body>
</html>

編寫元件

我們總共需要編寫3各元件，分別為

FileUpload.js：用form標籤的onSubmit和axios傳送上傳請求
Message.js：顯示資訊上傳成功伺服器錯誤或沒有選擇檔案
Progress.js：用axios的onUploadProgress和bootstrap顯示上傳進度條

FileUpload

import React, { useState } from 'react'
import axios from 'axios'
import Message from './Message'
import Progress from './Progress'

const FileUpload = () => {

  return (
    <div>
      {message ? <Message msg={message} /> : null}
      <form onSubmit={onSubmit}>
        <div className="custom-file mb-4">
          <input type="file" className="custom-file-input" id="customFile" onChange={onChange}></input>
          <label className="custom-file-label" htmlFor="customFile">{filename}</label>
        </div>
        <Progress percentage={uploadedPercentage}></Progress>
        <input className="btn btn-primary btn-block mt-4" type="submit" value="Upload"></input>
      </form>
      {
        uploadedFile ? 
          <div className="row mt-5">
            <div className="col-md-6 m-auto">
              <h3 className="text-center">{uploadedFile.name}</h3>
              <img style={{width:'100%'}} src={uploadedFile.filePath} alt=""></img>
            </div>
          </div> :
          <p>nothing uploaded yet...</p>
      }
    </div>
  )
}
export default FileUpload

Message.js

import React from 'react'
import PropTypes from 'prop-types'

const Message = ({msg}) => {
  console.log('her')
  return (
    <div className="alert alert-info alert-dismissible fade show" role="alert">
      {msg}
      <button type="button" className="close" data-dismiss="alert" aria-label="Close">
        <span aria-hidden="true">&times;</span>
      </button>
    </div>
  )
}
Message.propTypes = {
  msg: PropTypes.string.isRequired,
}
export default Message

Progress.js

import React from 'react'
import PropTypes from 'prop-types'

const Progress = ({percentage}) => {
  return (
    <div className="progress">
      <div className="progress-bar" role="progressbar" 
        style={{ width: `${percentage}%` }} 
        aria-valuenow={percentage} aria-valuemin="0" aria-valuemax="100">{percentage}%</div>
    </div>
  )
}
Progress.propTypes = {
  percentage: PropTypes.number.isRequired,
}
export default Progress