使用Laravel Excel在Laravel中实现CSV文件的导入和导出

Laravel是业界比较出色的PHP框架之一，其强大的功能和易于使用的API使得其深受开发者的喜爱。在实际开发中，我们经常需要进行数据的导入和导出工作，而CSV作为一种广泛应用的数据格式，也成为了常用的导入和导出格式之一。本文就将介绍如何使用 Laravel Excel扩展来进行 CSV 文件的导入和导出操作。

一、安装 Laravel Excel

首先，我们需要使用Composer来安装 Laravel Excel：

composer require maatwebsite/excel

安装完成后，我们需要在config/app.php 文件中添加以下代码到 providers 数组中：

MaatwebsiteExcelExcelServiceProvider::class,

添加以下代码到 aliases 数组中：

'Excel' => MaatwebsiteExcelFacadesExcel::class,

二、导出CSV文件

假设我们有一个用户模型 User ，它有一个 getExportData() 方法，该方法返回了要导出的数据。那么我们可以这样编写导出代码：

use MaatwebsiteExcelFacadesExcel;
use AppModelsUser;

class UserController extends Controller
{
    public function exportUsers()
    {
        return Excel::download(new UserExport(), 'users.csv');
    }
}

class UserExport implements FromQuery, WithHeadings
{
    public function query()
    {
        return User::query();
    }

    public function headings(): array
    {
        return [
            'ID',
            'Name',
            'Email',
            'Created At',
            'Updated At',
        ];
    }
}

在上面的代码中，我们使用了 Laravel Excel 的 FromQuery 和 WithHeadings 接口来快速导出数据到 CSV 文件。FromQuery 接口需要实现一个 query() 方法，返回要导出的数据集合；WithHeadings 接口需要实现一个 headings() 方法，返回 CSV 文件的表头信息。在导出操作中，我们使用 Excel::download() 方法来进行下载，传入两个参数：导出类 UserExport 和文件名 users.csv 。

当用户访问该路由时，就可以直接下载导出的CSV文件了。

三、导入CSV文件

要导入CSV文件，我们需要编写一个导入类并实现 FromCollection 接口。

假设我们有一个 User 导入模型，其中有一个 importUsers() 方法，该方法接受一个上传的 CSV 文件，并将数据导入到数据库中。我们可以这样写：

use MaatwebsiteExcelFacadesExcel;
use AppModelsUser;

class UserController extends Controller
{
    public function importUsers(Request $request)
    {
        $request->validate([
            'file' => 'required|mimes:csv,txt',
        ]);

        $path = $request->file('file')->getRealPath();
        $data = Excel::import(new UserImport(), $path);

        return redirect()->back()->with('success', '导入成功');
    }
}

class UserImport implements FromCollection
{
    public function collection(Collection $rows)
    {
        foreach ($rows as $row) {
            User::create([
                'name' => $row[0],
                'email' => $row[1],
            ]);
        }
    }
}

在上面的代码中，我们定义了一个 UserImport 类并实现了 FromCollection 接口。这里的 collection() 方法用于处理从CSV文件中导入的数据，将其转换为 Collection 对象。在这个例子中，我们简单地创建了一个用户，并用文件中的第一列作为用户名，第二列作为邮箱地址。

在实现导入功能时，我们需要使用 Excel::import() 方法来传入导入类和文件路径。该方法将返回导入数据的数组，我们可以将其传递到其他处理器中。

四、总结

使用 Laravel Excel 扩展，我们可以轻松地将 CSV 数据导入和导出到 Laravel 应用程序中。在上面的例子中，我们使用了 FromQuery、WithHeadings 和 FromCollection 接口来实现数据的导出和导入。当然，Laravel Excel 还支持其他接口，如 FromArray、WithTitle、WithMapping 等。在实际项目中，我们可以根据实际需求选择合适的接口来完成特定的数据导入和导出工作。