Laravel Maatwebsite-Excel 3.1 使用記錄

denfer發表於2020-03-23

匯出匯入的功能是平時開發比較常見的功能了，每次使用的都去網上找，這次就自己封裝一個簡單的通用版並記錄一下遇到的問題。

PHP: ^7.3.4
Laravel: ^5.7

composer require maatwebsite/excel

建立檔案
laravel Maatwebsite-Excel 3.1 使用記錄

然後在composer.json新增

laravel Maatwebsite-Excel 3.1 使用記錄
然後執行：

composer dump-autoload

export.php內

<?php
namespace App\Http\Libraries\ExcelUtil;


use Illuminate\Support\Collection;
use Maatwebsite\Excel\Concerns\FromCollection;
use Maatwebsite\Excel\Concerns\WithEvents;
use Maatwebsite\Excel\Concerns\WithHeadings;
use Maatwebsite\Excel\Events\AfterSheet;

class export implements FromCollection,WithHeadings, WithEvents
{
    protected $data;
    protected $headings;
    protected $columnWidth = [];//設定列寬       key：列  value:寬
    protected $rowHeight = [];  //設定行高       key：行  value:高
    protected $mergeCells = []; //合併單元格      key：第一個單元格  value:第二個單元格
    protected $font = [];       //設定字型       key：A1:K8  value:11
    protected $bold = [];       //設定粗體       key：A1:K8  value:true
    protected $background = []; //設定背景顏色    key：A1:K8  value:#F0F0F0F
    protected $vertical = [];   //設定定位       key：A1:K8  value:center

    //設定頁面屬性時如果無效   更改excel格式嘗試即可

    //建構函式傳值
    public function __construct($data, $headings)
    {
        $this->data = $data;
        $this->headings = $headings;
        $this->createData();
    }

    public function headings(): array
    {
        return $this->headings;
    }

    //陣列轉集合
    public function collection()
    {
        return new Collection($this->data);
    }
    //業務程式碼
    public function createData()
    {
        $this->data = collect($this->data)->toArray();
    }

    public function registerEvents(): array
    {
        return [
            AfterSheet::class  => function(AfterSheet $event) {
                //設定列寬
                foreach ($this->columnWidth as $column => $width) {
                    $event->sheet->getDelegate()
                        ->getColumnDimension($column)
                        ->setWidth($width);
                }
                //設定行高，$i為資料行數
                foreach ($this->rowHeight as $row => $height) {
                    $event->sheet->getDelegate()
                        ->getRowDimension($row)
                        ->setRowHeight($height);
                }

                //設定區域單元格垂直居中
                foreach ($this->vertical as $region => $position) {
                    $event->sheet->getDelegate()
                        ->getStyle($region)
                        ->getAlignment()
                        ->setVertical($position);
                }

                //設定區域單元格字型
                foreach ($this->font as $region => $value) {
                    $event->sheet->getDelegate()
                        ->getStyle($region)
                        ->getFont()
                        ->setSize($value);
                }

                //設定區域單元格字型粗體
                foreach ($this->bold as $region => $bool) {
                    $event->sheet->getDelegate()
                        ->getStyle($region)
                        ->getFont()
                        ->setBold($bool);
                }


                //設定區域單元格背景顏色
                foreach ($this->background as $region => $item) {
                    $event->sheet->getDelegate()->getStyle($region)->applyFromArray([
                        'fill' => [
                            'fillType' => 'linear', //線性填充，類似漸變
                            'startColor' => [
                                'rgb' => $item //初始顏色
                            ],
                            //結束顏色，如果需要單一背景色，請和初始顏色保持一致
                            'endColor' => [
                                'argb' => $item
                            ]
                        ]
                    ]);
                }
                //合併單元格
                foreach ($this->mergeCells as $start => $end) {
                    $event->sheet->getDelegate()->mergeCells($start.':'.$end);
                }

            }
        ];
    }

    /**
     * @return array
     * @2020/3/22 10:33
     * [
     *    'B' => 40,
     *    'C' => 60
     * ]
     */
    public function setColumnWidth (array $columnwidth)
    {
        $this->columnWidth = array_change_key_case($columnwidth, CASE_UPPER);
    }

    /**
     * @return array
     * @2020/3/22 10:33
     * [
     *    1 => 40,
     *    2 => 60
     * ]
     */
    public function setRowHeight (array $rowHeight)
    {
        $this->rowHeight = $rowHeight;
    }

    /**
     * @return array
     * @2020/3/22 10:33
     * [
     *    A1:K7 => 12
     * ]
     */
    public function setFont (array $fount)
    {
        $this->font = array_change_key_case($fount, CASE_UPPER);
    }

    /**
     * @return array
     * @2020/3/22 10:33
     * [
     *    A1:K7 => true
     * ]
     */
    public function setBold (array $bold)
    {
        $this->bold = array_change_key_case($bold, CASE_UPPER);
    }

    /**
     * @return array
     * @2020/3/22 10:33
     * [
     *    A1:K7 => F0FF0F
     * ]
     */
    public function setBackground (array $background)
    {
        $this->background = array_change_key_case($background, CASE_UPPER);
    }
}

在控制器內呼叫。

use App\Http\Libraries\ExcelUtil\export;
use Maatwebsite\Excel\Facades\Excel;

public function export () {
        $data = [];//要匯入的資料
        $header = [];//匯出頭
        $excel = new export($data, $header);
        $excel->setColumnWidth(['B' => 40, 'C' => 40]);
        $excel->setRowHeight([1 => 40, 2 => 50]);
        $excel->setFont(['A1:K7' => 12]);
        $excel->setBold(['A1:K7' => true]);
        $excel->setBackground(['A1:K7' => '808080']);
        return Excel::download($excel, '匯出的檔名.xlsx');
}

根據自己的需求可設定行、列、字型、背景顏色等；
樣式在有的excel格式上不起作用，具體不知道為什麼，沒有再去研究了；
數字過大時展示科學計數法問題，我借鑑了一個大佬的方法

Laravel使用excel3.1匯出時，防止長數字變科學計數法的方法

開啟預設配置檔案vendor/maatwebsite/excel/src/DefaultValueBinder.php，新增

use PhpOffice\PhpSpreadsheet\Cell\DataType;

函式內部新增：

//超過10位的數字轉文字格式，防止科學計數法
if (strlen($value) > 10) {
    $cell->setValueExplicit($value, DataType::TYPE_STRING);
    return true;
}

檔案程式碼最終如下：

namespace Maatwebsite\Excel;
use PhpOffice\PhpSpreadsheet\Cell\Cell;
use PhpOffice\PhpSpreadsheet\Cell\DefaultValueBinder as PhpSpreadsheetDefaultValueBinder;
use PhpOffice\PhpSpreadsheet\Cell\DataType;
class DefaultValueBinder extends PhpSpreadsheetDefaultValueBinder
{
    /**
     * @param Cell $cell Cell to bind value to
     * @param mixed $value Value to bind in cell
     *
     * @return bool
     */
    public function bindValue(Cell $cell, $value)
    {
        if (is_array($value)) {
            $value = \json_encode($value);
        }
        //超過10位的數字轉文字格式，防止科學計數法
        if (strlen($value) > 10) {
            $cell->setValueExplicit($value, DataType::TYPE_STRING);
            return true;
        }
        return parent::bindValue($cell, $value);
    }
}

如果要把匯出檔案先下載到伺服器上可以使用store方法

import.php內

<?php

namespace App\Http\Libraries\ExcelUtil;


use Illuminate\Support\Collection;
use Maatwebsite\Excel\Concerns\ToCollection;

class import implements ToCollection
{
    public $data;
    protected $delTitle;

    /**
     *
     * @param $title integer   //去掉幾行標題  預設一行
     */
    public function __construct($delTitle = 1)
    {
        $this->delTitle = $delTitle;
    }

    /**
     * @param Collection $rows
     * @2020/3/23 9:53
     */
    public function collection(Collection $rows)
    {
        $this->delTitle($rows);
        //$rows 是陣列格式
        $this->data = $rows;
    }

    public function delTitle (&$rows) {
        $rows = $rows->slice($this->delTitle)->values();
    }
}

控制器內呼叫

public function import (Request $request) {
  $path = $request->file('file');
  $delTitle = 1;//指定頭行數  刪除它
  $excel = new import($delTitle);
  Excel::import($excel, $path->getRealPath());
  dd($excel->data); //這個地方就可以獲取到檔案內的集合了

  //在這可以驗證資料  入庫操作
}

程式碼都是貼上就可以使用的，記錄完畢

本作品採用《CC 協議》，轉載必須註明作者和本文連結

Laravel Maatwebsite-Excel 3.1 實現匯出匯入
2020-03-23
LaravelWebExcel
windows使用Laravel Sail記錄
2021-07-01
WindowsLaravelAI
Laravel 使用個人經驗記錄
2020-03-12
Laravel
Laravel-admin 使用記錄
2018-11-25
Laravel
Laravel Excel 3.1
2019-10-24
LaravelExcel
Laravel Passport 使用快取優化記錄
2021-04-22
LaravelPassport快取優化
使用中介軟體記錄Laravel慢請求
2022-02-17
Laravel
Laravel 記錄相關
2019-06-15
Laravel
laravel踩坑記錄
2021-01-08
Laravel
3.1 - Laravel - 5.6 - Route - Group方法
2020-09-20
Laravel
使用 Laravel-snappy 生成 PDF 踩坑記錄
2019-03-21
LaravelAPP
Laravel 的觀察者使用記錄與兩種方式
2018-10-19
Laravel
Laravel sql 日誌記錄
2019-04-30
LaravelSQL
laravel-admin 使用經驗記錄一波
2022-07-22
Laravel
CentOS 部署 Laravel 應用記錄
2019-12-26
CentOSLaravel
Laravel7 踩坑記錄
2020-04-18
Laravel
docker+laravel+rabbitmq 搭建記錄
2021-11-10
DockerLaravelMQ
關於 Laravel 使用了 CDN 獲取真實 IP 記錄
2020-02-13
Laravel
簡單記錄一下 laravel-swoole 的基本使用
2020-08-04
Laravel
Laravel event 事件使用中記錄的一個小問題
2018-10-18
Laravel事件
Laravel maatwebsite/excel 3.1 匯出圖片
2020-08-06
LaravelWebExcel
Laravel-admin Excel 3.1 匯入
2019-11-04
LaravelExcel
Laravel-excel3.1最基礎用法
2021-12-24
LaravelExcel
記錄Laravel異常處理類
2020-07-25
Laravel
Laravel restful API 學習記錄一
2019-01-08
LaravelRESTAPI
Laravel 分組獲取最新記錄
2018-12-04
Laravel
laravel-echo-server 踩坑記錄
2020-09-15
LaravelServer
新手學習laravel踩坑記錄
2020-09-05
Laravel
Laravel 框架使用 whereIn 查詢 SQL 時資料出錯記錄
2019-11-06
Laravel框架SQL
關於Laravel中的Redis如何使用Lua的一點記錄
2020-11-13
LaravelRedis
記錄 dcat-admin 使用 Laravel-activitylog 記錄使用者行為過程中遇到的問題
2023-04-18
Laravel
Laravel Mix 編譯 Vue 踩坑記錄
2021-09-13
Laravel編譯Vue
Laravel-admin 的採坑記錄
2018-10-20
Laravel
Laravel unique驗證排除當前記錄
2020-12-04
Laravel
Laravel佇列相關問題記錄
2020-11-12
Laravel佇列
ubuntu16.04下CUDA9.1+OPENCV3.1安裝記錄
2017-12-18
UbuntuOpenCV
Laravel Validator 使用筆記
2017-06-29
Laravel筆記
Mac使用記錄
2019-06-09
Mac

Laravel Maatwebsite-Excel 3.1 使用記錄

相關文章