📘 Node.jsでExcelファイルを読み込む方法

!README-nodejs-xlsx-read.md

📘 Node.jsでExcelファイルを読み込む方法

• この記事のGistページ

この記事について

この記事ではNode.jsで SheetJS (npmパッケージ名はxlsx) を使ってExcelファイルを読み込む方法について紹介します。

おおまかな手順

おおまか手順を下記に示します。

1. Excelファイルの準備
2. コーディング
3. 動作確認

Excelファイルの準備

下表の内容で動作確認用のExcelファイルを作成し、ファイル名をdata.xlsxとして保存します。シート名についてはSheet1とします。なお、Excelファイルは data.xlsx からもダウンロード可能です。

Header 1	Header 2	Header 3
Row 1 Col 1	Row 1 Col 2	Row 1 Col 3
Row 2 Col 1	Row 2 Col 2	Row 2 Col 3
Row 3 Col 1	Row 3 Col 2	I am 髙橋

コーディング

ターミナルで下記のコマンドを実行してコーディングの準備をします。

mkdir nodejs-xlsx-read
cd nodejs-xlsx-read
npm init -y
npm install --save xlsx
touch main.js

main.js

エディタでmain.jsを開いて下記の内容を入力します。

クリックしてmain.jsへ移動

ポイントを下記に示します。

1. XLSX.readFile関数を使ってExcelファイルを読み込みます。
2. WorkbookオブジェクトのSheetsプロパティを使ってExcelシートを取得します。
3. XLSX.utils.sheet_to_json関数を使ってExcelシートをJSON配列に変換します。

動作確認

ターミナルで下記のコマンドを実行してJSON配列に変換できていることを確認します。

node main.js

実行結果を下記に示します。

[
  {
    "Header 1": "Row 1 Col 1",
    "Header 2": "Row 1 Col 2",
    "Header 3": "Row 1 Col 3"
  },
  {
    "Header 1": "Row 2 Col 1",
    "Header 2": "Row 2 Col 2",
    "Header 3": "Row 2 Col 3"
  },
  {
    "Header 1": "Row 3 Col 1",
    "Header 2": "Row 3 Col 2",
    "Header 3": "I am 髙橋"
  }
]

おわりに

個人的にはあまりExcelは好きではないですが、アプリの管理画面でマスタデータを一括登録する機能を設ける時などは下記3点の理由からCSVの代わりにExcelファイルを使うようにしています。

• 複数のシートを一括でアップロードできる
• 管理者さんがExcelからCSVに変換する手間を省ける
• 文字コードの問題に悩まされることが少ない（Shift_JISだと髙橋さんを登録できない、不慣れな人から「ExcelでCSVテンプレートを開くと文字化けしている」と言われる）

Excel入出力は帳票出力と並んで日本の業務システム開発における回避し難い2大要件だと考えていますが、他にも忘れているものがありましたら気軽にコメントをいただければ幸いです、その他のコメントも大歓迎です。最後までお読みいただきありがとうございました！

関連記事

• Node.jsでCSVファイルを読み込む方法

.gitignore

/node_modules/
/package-lock.json
# Do not ignore package-lock.json other than gist.

data.xlsx

main.js

const path = require('path')
const XLSX = require('xlsx')

async function main () {
  const source = path.join(__dirname, 'data.xlsx')
  const workbook = XLSX.readFile(source) // <1>
  const sheet = workbook.Sheets['Sheet1'] // <2>
  const rows = XLSX.utils.sheet_to_json(sheet) // <3>

  console.log(JSON.stringify(rows, null, 2))
}

if (require.main === module) {
  main()
}

package.json

{
  "name": "nodejs-xlsx-read",
  "version": "1.0.0",
  "description": "",
  "main": "main.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "xlsx": "^0.18.5"
  }
}