Laravel Yajra DataTables 关系列排序与ID获取最佳实践

Laravel Yajra DataTables 关系列排序与ID获取最佳实践

本文深入探讨laravel Yajra DataTables在处理关联模型数据时的常见问题,特别是关系列排序失效和action列中ID混淆的挑战。通过详细分析with与join的区别,文章提供了一种高效且可靠的解决方案,即利用sql JOIN操作并配合列别名,确保关联数据正确排序并获取准确的行ID,从而优化数据表的显示与交互体验。

在使用laravel yajra datatables构建复杂数据列表时,开发者经常会遇到需要显示和排序关联模型数据的情况。然而,直接使用eloquent的with()方法进行关联加载,并尝试对关联字段进行排序或在自定义列(如操作列)中获取主表id时,可能会遇到“列未找到”的错误或id错乱的问题。

理解问题根源:with() 与 JOIN 的差异

Laravel Eloquent的with()方法用于实现“预加载”(Eager Loading),它会执行额外的SQL查询来获取关联数据,然后将这些数据“注入”到主模型实例中。这种方式减少了N+1查询问题,但在Yajra DataTables的上下文环境中,它并没有将关联表直接JOIN到主查询中。因此,当DataTable尝试对一个未通过JOIN引入的关联列进行排序时,数据库会报告该列不存在,因为主查询中确实没有这个列。

同时,在action列等自定义列的回调函数中,如果DataTable的eloquent($query)方法没有明确指定选择主表的全部列(例如kabupaten.*),或者在query()方法中进行了隐式的列选择,可能导致传递给视图的$id变量指向关联表的ID而非主表的ID,造成数据操作混乱。

解决方案:使用 JOIN 操作与列别名

解决上述问题的关键在于,明确地在DataTable的query()方法中使用SQL JOIN语句将关联表连接进来,并为关联列设置一个唯一的别名,以便DataTable能够识别并对其进行排序。同时,确保明确选择主表的所有列,以避免ID混淆。

1. 修改 query() 方法

将KabupatenDataTable中的query()方法从使用with()改为使用leftJoin()。leftJoin确保即使没有匹配的关联数据,主表的数据也能被显示。通过addSelect()方法,我们明确地选择了kabupaten表的所有列(kabupaten.*),以及provinsi表的provinsi列,并为其指定了别名provinsi_provinsi。

<?php  namespace AppDataTables;  use AppModelsKabupaten; use YajraDataTablesHtmlButton; use YajraDataTablesHtmlcolumn; use YajraDataTablesServicesDataTable;  class KabupatenDataTable extends DataTable {     /**      * Build DataTable class.      *      * @param mixed $query Results from query() method.      * @return YajraDataTablesDataTableAbstract      */     public function dataTable($query)     {         return datatables()             ->eloquent($query)             ->addIndexColumn()             ->addColumn('kordinat', function(Kabupaten $kabupaten) {                 // 这里的 $kabupaten 对象现在包含通过 JOIN 获取的 provinsi 属性                 return $kabupaten->koordinat_bujur . "," . $kabupaten->koordinat_lintang;             })             ->addColumn('action', 'kabupaten.action');     }      /**      * Get query source of dataTable.      *      * @param AppModelsKabupaten $model      * @return IlluminateDatabaseEloquentBuilder      */     public function query(Kabupaten $model)     {         // 使用 leftJoin 明确连接 provinsi 表         return Kabupaten::query()             ->leftJoin('provinsi', 'provinsi.id', '=', 'kabupaten.provinsi_id')             ->addSelect([                 'kabupaten.*', // 确保选择 kabupaten 表的所有列,包括其 ID                 'provinsi.provinsi as provinsi_provinsi' // 为关联列设置别名             ]);     }      /**      * Optional method if you want to use html builder.      *      * @return YajraDataTablesHtmlBuilder      */     public function html()     {         return $this->builder()                     ->setTableId('kabupaten-table')                     ->columns($this->getColumns())                     ->minifiedAjax()                     ->dom('Bfrtip')                     ->orderBy(1) // 根据实际列顺序调整                     ->parameters([                         'buttons' => ['excel'],                     ])                     ->buttons(                         Button::make('create'),                         Button::make('export'),                         Button::make('print'),                         Button::make('reset'),                         Button::make('reload')                     );     }      /**      * Get columns.      *      * @return array      */     protected function getColumns()     {         return [             Column::make('DT_RowIndex')->title('No')->orderable(false)->searchable(false),             // 使用别名定义列,并设置 name 属性以支持排序             Column::make('provinsi_provinsi')->name('provinsi_provinsi')->title('Provinsi'),             Column::make('status'),             Column::make('kabupaten')->title('Nama kabupaten'),             Column::make('ketinggian'),             Column::make('kordinat')                 ->exportable(false)                 ->printable(false),             Column::computed('action')                 ->exportable(false)                 ->printable(false),         ];     }      /**      * Get filename for export.      *      * @return string      */     protected function filename()     {         return 'Kabupaten_' . date('YmdHis');     } }

2. 更新 getColumns() 方法

在getColumns()方法中,将原来的Column::make(‘provinsi.provinsi’)改为使用我们为关联列设置的别名,并通过name()方法明确指定用于排序的列名,这必须与addSelect中定义的别名一致。

// ... (在 KabupatenDataTable 类的 getColumns 方法中) protected function getColumns() {     return [         Column::make('DT_RowIndex')->title('No')->orderable(false)->searchable(false),         // 使用别名定义列,并设置 name 属性以支持排序         Column::make('provinsi_provinsi')->name('provinsi_provinsi')->title('Provinsi'),         Column::make('status'),         Column::make('kabupaten')->title('Nama kabupaten'),         Column::make('ketinggian'),         Column::make('kordinat')             ->exportable(false)             ->printable(false),         Column::computed('action')             ->exportable(false)             ->printable(false),     ]; }

3. 确保 action 列正确获取ID

由于我们在query()方法中使用了addSelect([‘kabupaten.*’, …]),Yajra DataTables在处理每一行数据时,会优先使用主模型(Kabupaten)的属性。因此,在kabupaten.action视图中,$id变量将正确地指向kabupaten.id,而不是provinsi.id。

{{-- resources/views/kabupaten/action.blade.php --}} <form id="delete_form" method="POST">      @csrf     @method('DELETE') </form> <a type="button" href="{{route('adm.kabupaten.show', ['id' => $id])}}" class="btn btn-just-icon btn-round btn-sm btn-info" data-toggle="tooltip" data-placement="bottom" title="detail">     <i class="fa fa-eye"></i> </a> <a href="{{route('adm.kabupaten.edit', ['id' => $id])}}" class="btn btn-just-icon btn-round btn-sm btn-primary" data-toggle="tooltip" data-placement="bottom" title="ubah">     <i class="fa fa-edit"></i> </a> <a href="#" data-url="{{ route('adm.kabupaten.destroy', $id) }}" class="btn btn-just-icon btn-round btn-sm btn-danger" onclick="return deleteConfirm(this);">     <i class="fa fa-trash"></i> </a>  <script>     $(function() {         $('[data-toggle="tooltip"]').tooltip();     }) </script>

在此视图中,$id将始终是kabupaten模型的ID。

注意事项与最佳实践

  • 选择 JOIN 类型:
    • leftJoin:保留左表(主表)的所有记录,即使右表(关联表)没有匹配项。
    • innerJoin:只返回两表都有匹配项的记录。根据业务需求选择合适的JOIN类型。
  • 明确选择列: 始终使用addSelect()并明确指定要查询的列,尤其是主表名.*,这有助于避免列冲突和ID混淆。
  • 列别名: 为关联表的列设置清晰的别名,可以避免与主表列名冲突,并提高代码可读性
  • 性能考量: 对于非常大的数据集和复杂的JOIN操作,可能会影响查询性能。确保数据库索引已正确设置在JOIN键和排序列上。
  • 多重关联: 如果需要显示和排序多个关联模型的数据,可以链式调用leftJoin()和addSelect()来引入更多表和列。

通过上述方法,您可以有效地解决Laravel Yajra DataTables中关联列排序失效和ID获取不准确的问题,从而构建出功能完善且性能优越的数据表格。

© 版权声明
THE END
喜欢就支持一下吧
点赞6 分享