注意:excel模板文件是后台规定的,规定需要上传哪些数据
Excel导入
流程:
- 提前准备好 Excel 模板
- 绘制页面结构,通过隐藏域,开始上传文件,选中文件
- 使用隐藏域读取文件以后,需要使用 XLSX 插件读取 Excel 中的内容
- 读取excel文件中的内容,读取以后发现不符合后端的要求
- 需要将excel中的数据进行格式化,格式化成后端需要使用的数据
- 使用AJAX将格式化好的数据按照接口的要求,传递给后端
- 后端接收到数据以后,将数据存到数据库中
解析vue-element-admin框架实现方案:
框架提供两个组件:
父组件:接收子组件解析的内容,进行上传处理
子组件:读取、解析文件内容,传递给父组件
子组件:
绘制隐藏域,选择文件
选择好文件以后开始进行解析,XLSX 插件进行解析(表头、具体内容)
解析vue-element-admin框架代码:
根据路由,找到导入的上传功能组件,分析导入的子组件(上传逻辑)
使用子组件过程中,传递了两个属性,两个属性对应的参数类型是函数(在父组件定义的方法)
子组件定义props接收了两个传递的属性
父组件定义的方法:上传之前的逻辑和上传成功以后的逻辑
子组件代码具体解析
<template>
<div>
<!-- 绘制隐藏域 -->
<!-- 当选择文件以后,会触发 change 事件 -->
<input ref="excel-upload-input" class="excel-upload-input" type="file" accept=".xlsx, .xls" @change="handleClick">
<!-- 拖拽和上传按钮 -->
<div class="drop" @drop="handleDrop" @dragover="handleDragover" @dragenter="handleDragover">
Drop excel file here or
<!-- 点击按钮,触发 click ,在回调函数中 -->
<el-button :loading="loading" style="margin-left:16px;" size="mini" type="primary" @click="handleUpload">
Browse
</el-button>
</div>
</div>
</template>
<script>
import XLSX from 'xlsx'
export default {
name: 'UploadExcel',
// 子组件定义 props 传递的属性
props: {
beforeUpload: Function, // eslint-disable-line
onSuccess: Function// eslint-disable-line
},
data() {
return {
loading: false,
excelData: {
header: null,
results: null
}
}
},
methods: {
generateData({ header, results }) {
this.excelData.header = header
this.excelData.results = results
// 将解析好的表头和具体内容传递给父组件
this.onSuccess && this.onSuccess(this.excelData)
},
handleDrop(e) {
e.stopPropagation()
e.preventDefault()
if (this.loading) return
const files = e.dataTransfer.files
if (files.length !== 1) {
this.$message.error('Only support uploading one file!')
return
}
const rawFile = files[0] // only use files[0]
if (!this.isExcel(rawFile)) {
this.$message.error('Only supports upload .xlsx, .xls, .csv suffix files')
return false
}
this.upload(rawFile)
e.stopPropagation()
e.preventDefault()
},
handleDragover(e) {
e.stopPropagation()
e.preventDefault()
e.dataTransfer.dropEffect = 'copy'
},
handleUpload() {
this.$refs['excel-upload-input'].click()
},
// 选择文件以后触发的方法
handleClick(e) {
// 获取到上传的文件对象
const files = e.target.files
// 获取到上传的具体文件
const rawFile = files[0] // only use files[0]
if (!rawFile) return
// 在读取到文件以后,就开始交给 upload 方法
this.upload(rawFile)
},
upload(rawFile) {
this.$refs['excel-upload-input'].value = null // fix can't select the same excel
// 查看组件使用有没有传递 beforeUpload 方法
if (!this.beforeUpload) {
// 将上传的文件传递给 readerData 方法,进行解析
this.readerData(rawFile)
return
}
// 将上传的文件传递给 beforeUpload
// 传递给组件使用者以后,组件使用者开始验证,文件类型以及文件大小是否符合要求
const before = this.beforeUpload(rawFile)
if (before) {
// 将上传的文件传递给 readerData 方法,进行解析
this.readerData(rawFile)
}
},
readerData(rawFile) {
this.loading = true
return new Promise((resolve, reject) => {
// 实例化读取文件的 FileReader 对象
const reader = new FileReader()
// 当读取完文件以后,执行 onload
reader.onload = e => {
// 读取的全部文件的内容
const data = e.target.result
// 使用 XLSX 插件读取上传的数据,开始进行解析
const workbook = XLSX.read(data, { type: 'array' })
const firstSheetName = workbook.SheetNames[0]
const worksheet = workbook.Sheets[firstSheetName]
const header = this.getHeaderRow(worksheet)
const results = XLSX.utils.sheet_to_json(worksheet)
// header 是表头
// results 是具体内容
this.generateData({ header, results })
this.loading = false
resolve()
}
reader.readAsArrayBuffer(rawFile)
})
},
getHeaderRow(sheet) {
const headers = []
const range = XLSX.utils.decode_range(sheet['!ref'])
let C
const R = range.s.r
/* start in the first row */
for (C = range.s.c; C <= range.e.c; ++C) { /* walk every column in the range */
const cell = sheet[XLSX.utils.encode_cell({ c: C, r: R })]
/* find the cell in the first row */
let hdr = 'UNKNOWN ' + C // <-- replace with your desired default
if (cell && cell.t) hdr = XLSX.utils.format_cell(cell)
headers.push(hdr)
}
return headers
},
isExcel(file) {
return /\.(xlsx|xls|csv)$/.test(file.name)
}
}
}
</script>
<style scoped>
.excel-upload-input{
display: none;
z-index: -9999;
}
.drop{
border: 2px dashed #bbb;
width: 600px;
height: 160px;
line-height: 160px;
margin: 0 auto;
font-size: 24px;
border-radius: 5px;
text-align: center;
color: #bbb;
position: relative;
}
</style>
父组件代码
<template>
<div class="app-container">
<upload-excel-component :on-success="handleSuccess" :before-upload="beforeUpload" />
<el-table :data="tableData" border highlight-current-row style="width: 100%;margin-top:20px;">
<el-table-column v-for="item of tableHeader" :key="item" :prop="item" :label="item" />
</el-table>
</div>
</template>
<script>
import UploadExcelComponent from '@/components/UploadExcel/index.vue'
export default {
name: 'UploadExcel',
components: { UploadExcelComponent },
data() {
return {
tableData: [],
tableHeader: []
}
},
methods: {
beforeUpload(file) {
const isLt1M = file.size / 1024 / 1024 < 1
if (isLt1M) {
return true
}
this.$message({
message: 'Please do not upload files larger than 1m in size.',
type: 'warning'
})
return false
},
handleSuccess({ results, header }) {
this.tableData = results
this.tableHeader = header
}
}
}
</script>
Excel导入出
导出功能介绍
- 前端使用 AJAX 向后端发起请求,请求需要导出的数据
- 后端会将数据返回,但是返回的数据是 JSON 格式的数据,并不符合 Excel 或者 XLSX插件的要求
- 需要后端返回的数据进行格式化,格式化成 Excel 需要使用的格式
- 需要借助插件(XLSX)将格式化好的数据导出成 Excel 文件
具体说明:
1、插件包位于
src/vendor/export2Excel
中,采用的是按需引入的方式什么时候正式要使用导出功能了,插件才会被正式引入到应用里
import('@/vendor/Export2Excel').then(excel => {})
2、Export2Excel
依赖的包有js-xlsx
、file-saver
和script-loader
也就是说,在项目跑起来之前要安装依赖
npm install file-saver script-loader --save
3、导出需要两个文件,在vendor文件夹下,Export2Excel.js和Export2Zip.js
需要从原代码中拷贝
给导出按钮添加点击事件
// 导出 Excel
downloadExcel() {
import('@/vendor/Export2Excel').then(excel => {
// excel表示导入的模块对象
excel.export_json_to_excel({
header: ['姓名', '工资'], // 表头 必填
data: [
['刘备', 100],
['关羽', 500]
], // 具体数据 必填
filename: 'excel-list', // 文件名称
autoWidth: true, // 宽度是否自适应
bookType: 'xlsx' // 生成的文件类型
})
})
}
Excel导出参数说明
参数 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
header | 导出数据的表头 | Array | / | [] |
data | 导出的具体数据 | Array | / | [[]] |
filename | 导出文件名 | String | / | excel-list |
autoWidth | 单元格是否要自适应宽度 | Boolean | true / false | true |
bookType | 导出文件类型 | String | xlsx, csv, txt, more | xlsx |
核心功能导入与导出解析:
这个组件引入了 xlsx 包, 因此我们需要提前安装
Excel 的导入导出都是依赖于xlsx来实现的(https://github.com/SheetJS/js-xlsx )
作者在在
xlsx
的基础上又封装了Export2Excel.js来方便导出数据由于
Export2Excel
不仅依赖xlsx
还依赖file-saver
和script-loader
说白了:导入导出功能核心包都是 xlsx,只不过导出功能又依赖其他两个包,所以需要安装 3 个包
(用cnpm下载比较快,使用cnpm需要用npm提前下载)
npm install xlsx file-saver -S
npm install script-loader -S -D