前端實現Excel導入和導出功能

介紹

最近項目中讓實現一個導入導出Excel的功能，查找了一些插件後發現js-xlsx這個插件，因此就嘗試使用了一下，這裏將使用方法和遇到的問題簡單記錄一下。

SheetJS js-xlsx 是一款可以讀寫多種格式表格的插件，瀏覽器支持良好，而且能在多個語言平臺上使用，目前在 github 上有 14k 個 star。
插件地址：https://github.com/SheetJS/js...

使用

1.安裝依賴

進入項目文件夾，安裝 xlsx

yarn add xlsx

2.在項目中引入

import * as XLSX from 'xlsx'

導出Excel功能實現

1.定義導出時須要使用的方法

export default function download(json,fileName){
    const type = 'xlsx'//定義導出文件的格式
    var tmpDown;//導出的內容
    var tmpdata = json[0];
    json.unshift({});
    var keyMap = []; //獲取keys
    for (var k in tmpdata) {
        keyMap.push(k);
        json[0][k] = k;
    }
    var tmpdata = [];//用來保存轉換好的json 
    
    json.map((v, i) => keyMap.map((k, j) => Object.assign({}, {
        v: v[k],
        position: (j > 25 ? getCharCol(j) : String.fromCharCode(65 + j)) + (i + 1)
    }))).reduce((prev, next) => prev.concat(next)).forEach((v, i) => tmpdata[v.position] = {
        v: v.v
    });
    var outputPos = Object.keys(tmpdata); //設置區域,好比表格從A1到D10
    var tmpWB = {
        SheetNames: ['mySheet'], //保存的表標題
        Sheets: {
            'mySheet': Object.assign({},
                tmpdata, //內容
                {
                    '!ref': outputPos[0] + ':' + outputPos[outputPos.length - 1] //設置填充區域
                })
        }
    };
    tmpDown = new Blob([s2ab(XLSX.write(tmpWB, 
        {bookType: (type == undefined ? 'xlsx':type),bookSST: false, type: 'binary'}//這裏的數據是用來定義導出的格式類型
        ))], {
        type: ""
    }); //建立二進制對象寫入轉換好的字節流
    saveAs(tmpDown,fileName);
}

function saveAs(obj, fileName){//導出功能實現
    var tmpa = document.createElement("a");
    tmpa.download = fileName || "下載";
    tmpa.href = URL.createObjectURL(obj); //綁定a標籤
    tmpa.click(); //模擬點擊實現下載
    setTimeout(function () { //延時釋放
        URL.revokeObjectURL(obj); //用URL.revokeObjectURL()來釋放這個object URL
    }, 100);
}

function s2ab(s){ //字符串轉字符流
    var buf = new ArrayBuffer(s.length);
    var view = new Uint8Array(buf);
    for (var i = 0; i != s.length; ++i) view[i] = s.charCodeAt(i) & 0xFF;
    return buf;
}

function getCharCol(n){
    let temCol = '',
    s = '',
    m = 0
    while (n > 0) {
        m = n % 26 + 1
        s = String.fromCharCode(m + 64) + s
        n = (n - m) / 26
    }
    return s
}

2.項目中使用導出方法

//導出excel
//導出excel
downloadExl = () => {
    const { results } = this.props //須要導出的json數據
    let datas = _.clone(results)//這裏爲了避免影響項目的數據的使用 採用了lodash中的深克隆方法
    let json = datas.map(item=> { //將json數據的鍵名更換成導出時須要的鍵名
        return {
            '人員ID' :item.id,
            '姓名' : item.name,
            '證件類型': this.findIdType(item.idType),//將類型代號轉爲漢字
            '證件號碼': item.credentialsId,
            '固定電話': item.tel,
            '移動電話': item.mobile
        }
    })
    download(json,'人員信息.xlsx')//導出的文件名
}

3.綁定事件

<Button onClick={this.downloadExl}>導出Excel</Button>

這樣就能輕鬆實現Excel的導出功能了

導入Excel功能實現

1.定義導入時須要使用的方法

//導入excel
onImportExcel = file => {
    // 獲取上傳的文件對象
    const { files } = file.target;
    // 經過FileReader對象讀取文件
    const fileReader = new FileReader();
    fileReader.onload = event => {
        try {
            const { result } = event.target;
            // 以二進制流方式讀取獲得整份excel表格對象
            const workbook = XLSX.read(result, { type: 'binary' });
            // 存儲獲取到的數據
            let data = [];
            // 遍歷每張工做表進行讀取（這裏默認只讀取第一張表）
            for (const sheet in workbook.Sheets) {
            // esline-disable-next-line
            if (workbook.Sheets.hasOwnProperty(sheet)) {
                // 利用 sheet_to_json 方法將 excel 轉成 json 數據
                data = data.concat(XLSX.utils.sheet_to_json(workbook.Sheets[sheet]));
                // break; // 若是隻取第一張表，就取消註釋這行
            }
        }
        // 最終獲取到而且格式化後的 json 數據
        const uploadData = data.map(item=> {
            return {
                id : Number(item['人員ID']),
                name : item['姓名'],
                idType: this.findIdType(item['證件類型'],'string'),
                credentialsId: item['證件號碼'],
                tel: item['固定電話'],
                mobile: item['移動電話']
            }
        })
        console.log(uploadData)//這裏獲得了後端須要的json數據，調用接口傳給後端就好了
        message.success('上傳成功！') //這裏用了antd中的message組件
        } catch (e) {
            // 這裏能夠拋出文件類型錯誤不正確的相關提示
            message.error('文件類型不正確！');
        }
    };
    // 以二進制方式打開文件
    fileReader.readAsBinaryString(files[0]);
}

2.綁定事件

<Button className={Styles.upload_wrap}>
    導入Excel
    <input className={Styles.file_uploader} type='file' accept='.xlsx, .xls' onChange={this.onImportExcel} /> 
    //這裏對原有的input樣式進行了修改，accept 屬性定義了上傳文件支持的類型，onChange 操做中的 importExcel 方法定義了上傳文件時執行的操做。 
</Button>

3.修改樣式

.upload_wrap {
  display: inline-block;
  position: relative;
  width: 94px;
  padding: 3px 5px;
  overflow: hidden;
}

.file_uploader {
  position: absolute;
  width: 100%;
  height: 100%;
  top: 0;
  left: 0;
  outline: none;
  opacity: 0;
  background-color: transparent;
}

.upload_text {
  display: inline-block;
  margin-left: 5px;
}

.upload_tip {
  display: inline-block;
  margin-left: 10px;
  color: #999;
}

4.針對文件上傳和讀取結果分別作了對應的提示（這裏使用 ant design 中的 message 組件）

5.獲得的json數據

導入導出功能就這樣實現了，是否是很簡單。