fleetbase/laravel-mysql-spatial

Laravel 和 Fleetbase 的 MySQL 空间数据类型扩展。

维护者

详细信息

github.com/fleetbase/laravel-mysql-spatial

源代码

问题

安装量: 6,901

依赖项: 4

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 1

开放问题: 0

1.0.2 2024-02-15 18:28 UTC

Requires

Requires (Dev)

MIT 3dd0c72de5758eea0ec499620c8fed8babb85cb6

  • Joseph Estefane <estefanejoe.woop@gmail.com>
  • Fleetbase Pte Ltd <hello.woop@fleetbase.io>

This package is auto-updated.

Last update: 2024-09-15 19:47:41 UTC

README

Packagist Packagist license

Laravel 包，用于轻松处理 MySQL 空间数据类型 和 MySQL 空间函数。这是从著名的 grimzy/laravel-mysql-spatial 维护分支，适用于 Laravel 9x 和 10x。

请检查您 MySQL 版本的文档。MySQL 的空间数据扩展自 MySQL 5.5 开始添加，但在 5.6 和 5.7 中许多空间函数都发生了变化。

此包也支持 MariaDB。请参阅 MySQL/MariaDB 空间支持矩阵 以了解兼容性。

安装

使用 composer 添加包

$ composer require fleetbase/laravel-mysql-spatial

快速入门

创建迁移

从命令行

php artisan make:migration create_places_table

然后通过在迁移中添加至少一个空间数据字段来编辑您刚刚创建的迁移。对于 5.5 之前的 Laravel 版本，您可以使用此包提供的 Blueprint（Fleetbase\LaravelMysqlSpatial\Schema\Blueprint）。

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;

// For Laravel < 5.5
// use Fleetbase\LaravelMysqlSpatial\Schema\Blueprint;

class CreatePlacesTable extends Migration {

    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('places', function(Blueprint $table)
        {
            $table->increments('id');
            $table->string('name')->unique();
            // Add a Point spatial data field named location
            $table->point('location')->nullable();
            // Add a Polygon spatial data field named area
            $table->polygon('area')->nullable();
            $table->timestamps();
        });
  
        // Or create the spatial fields with an SRID (e.g. 4326 WGS84 spheroid)
  
        // Schema::create('places', function(Blueprint $table)
        // {
        //     $table->increments('id');
        //     $table->string('name')->unique();
        //     // Add a Point spatial data field named location with SRID 4326
        //     $table->point('location', 4326)->nullable();
        //     // Add a Polygon spatial data field named area with SRID 4326
        //     $table->polygon('area', 4326)->nullable();
        //     $table->timestamps();
        // });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::drop('places');
    }
}

运行迁移

php artisan migrate

创建模型

从命令行

php artisan make:model Place

然后编辑您刚刚创建的模型。它必须使用 SpatialTrait 并定义一个名为 $spatialFields 的数组，其中包含在迁移中创建的 MySQL 空间数据字段名称（示例在 快速入门）。

namespace App;

use Illuminate\Database\Eloquent\Model;
use Fleetbase\LaravelMysqlSpatial\Eloquent\SpatialTrait;

/**
 * @property \Fleetbase\LaravelMysqlSpatial\Types\Point   $location
 * @property \Fleetbase\LaravelMysqlSpatial\Types\Polygon $area
 */
class Place extends Model
{
    use SpatialTrait;

    protected $fillable = [
        'name'
    ];

    protected $spatialFields = [
        'location',
        'area'
    ];
}

保存模型

use Fleetbase\LaravelMysqlSpatial\Types\Point;
use Fleetbase\LaravelMysqlSpatial\Types\Polygon;
use Fleetbase\LaravelMysqlSpatial\Types\LineString;

$place1 = new Place();
$place1->name = 'Empire State Building';

// saving a point
$place1->location = new Point(40.7484404, -73.9878441);	// (lat, lng)
$place1->save();

// saving a polygon
$place1->area = new Polygon([new LineString([
    new Point(40.74894149554006, -73.98615270853043),
    new Point(40.74848633046773, -73.98648262023926),
    new Point(40.747925497790725, -73.9851602911949),
    new Point(40.74837050671544, -73.98482501506805),
    new Point(40.74894149554006, -73.98615270853043)
])]);
$place1->save();

或者如果您创建数据库字段时使用了特定的 SRID

use Fleetbase\LaravelMysqlSpatial\Types\Point;
use Fleetbase\LaravelMysqlSpatial\Types\Polygon;
use Fleetbase\LaravelMysqlSpatial\Types\LineString;

$place1 = new Place();
$place1->name = 'Empire State Building';

// saving a point with SRID 4326 (WGS84 spheroid)
$place1->location = new Point(40.7484404, -73.9878441, 4326);	// (lat, lng, srid)
$place1->save();

// saving a polygon with SRID 4326 (WGS84 spheroid)
$place1->area = new Polygon([new LineString([
    new Point(40.74894149554006, -73.98615270853043),
    new Point(40.74848633046773, -73.98648262023926),
    new Point(40.747925497790725, -73.9851602911949),
    new Point(40.74837050671544, -73.98482501506805),
    new Point(40.74894149554006, -73.98615270853043)
])], 4326);
$place1->save();

注意：在保存集合几何图形（LineString、Polygon、MultiPoint、MultiLineString 和 GeometryCollection）时，仅最顶层的几何图形应在构造函数中设置 SRID。

在上面的示例中，在创建 new Polygon() 时，我们仅在 Polygon 上设置了 SRID，并使用默认值设置了 LineString 和 Point 对象。

检索模型

$place2 = Place::first();
$lat = $place2->location->getLat();	// 40.7484404
$lng = $place2->location->getLng();	// -73.9878441

几何类

可用的几何类

查看 类图。

使用几何类

为了使您的 Eloquent 模型能够处理几何类，它必须使用 Fleetbase\LaravelMysqlSpatial\Eloquent\SpatialTrait 特性，并定义一个 protected 属性 $spatialFields，作为 MySQL 空间数据类型列名称的数组（示例在 快速入门）。

IteratorAggregate 和 ArrayAccess

集合几何图形（LineString、Polygon、MultiPoint、MultiLineString 和 GeometryCollection）实现了 IteratorAggregate 和 ArrayAccess，这使得执行迭代器和数组操作变得容易。例如

$polygon = $multipolygon[10];	// ArrayAccess

// IteratorAggregate
for($polygon as $i => $linestring) {
  echo (string) $linestring;
}

辅助工具

从/到 Well Known Text（《WKT》）
// fromWKT($wkt, $srid = 0)
$point = Point::fromWKT('POINT(2 1)');
$point->toWKT();	// POINT(2 1)

$polygon = Polygon::fromWKT('POLYGON((0 0,4 0,4 4,0 4,0 0),(1 1, 2 1, 2 2, 1 2,1 1))');
$polygon->toWKT();	// POLYGON((0 0,4 0,4 4,0 4,0 0),(1 1, 2 1, 2 2, 1 2,1 1))
从/到 String
// fromString($wkt, $srid = 0)
$point = new Point(1, 2);	// lat, lng
(string)$point			// lng, lat: 2 1

$polygon = Polygon::fromString('(0 0,4 0,4 4,0 4,0 0),(1 1, 2 1, 2 2, 1 2,1 1)');
(string)$polygon;	// (0 0,4 0,4 4,0 4,0 0),(1 1, 2 1, 2 2, 1 2,1 1)
从/到 JSON（《GeoJSON》）

几何类实现了 JsonSerializable 和 Illuminate\Contracts\Support\Jsonable，以帮助将其序列化为 GeoJSON

$point = new Point(40.7484404, -73.9878441);

json_encode($point); // or $point->toJson();

// {
//   "type": "Feature",
//   "properties": {},
//   "geometry": {
//     "type": "Point",
//     "coordinates": [
//       -73.9878441,
//       40.7484404
//     ]
//   }
// }

要将 GeoJSON 字符串反序列化为几何类，您可以使用 Geometry::fromJson($json_string)

$location = Geometry::fromJson('{"type":"Point","coordinates":[3.4,1.2]}');
$location instanceof Point::class;  // true
$location->getLat();  // 1.2
$location->getLng()); // 3.4

作用域：空间分析函数

空间分析函数是通过使用Eloquent 本地作用域实现的。

可用作用域

  • distance($geometryColumn, $geometry, $distance)
  • distanceExcludingSelf($geometryColumn, $geometry, $distance)
  • distanceSphere($geometryColumn, $geometry, $distance)
  • distanceSphereExcludingSelf($geometryColumn, $geometry, $distance)
  • comparison($geometryColumn, $geometry, $relationship)
  • within($geometryColumn, $polygon)
  • crosses($geometryColumn, $geometry)
  • contains($geometryColumn, $geometry)
  • disjoint($geometryColumn, $geometry)
  • equals($geometryColumn, $geometry)
  • intersects($geometryColumn, $geometry)
  • overlaps($geometryColumn, $geometry)
  • doesTouch($geometryColumn, $geometry)
  • orderBySpatial($geometryColumn, $geometry, $orderFunction, $direction = 'asc')
  • orderByDistance($geometryColumn, $geometry, $direction = 'asc')
  • orderByDistanceSphere($geometryColumn, $geometry, $direction = 'asc')

请注意，MySQL 空间分析函数的行为和可用性在不同版本的 MySQL 中有所不同（参见文档）。

迁移

对于 5.5 版本之前的 Laravel，您可以使用此包提供的 Blueprint：Fleetbase\LaravelMysqlSpatial\Schema\Blueprint。

use Illuminate\Database\Migrations\Migration;
use Fleetbase\LaravelMysqlSpatial\Schema\Blueprint;

class CreatePlacesTable extends Migration {
    // ...
}

列

可用的MySQL 空间类型迁移 Blueprint

  • $table->geometry(string $column_name, int $srid = 0)
  • $table->point(string $column_name, int $srid = 0)
  • $table->lineString(string $column_name, int $srid = 0)
  • $table->polygon(string $column_name, int $srid = 0)
  • $table->multiPoint(string $column_name, int $srid = 0)
  • $table->multiLineString(string $column_name, int $srid = 0)
  • $table->multiPolygon(string $column_name, int $srid = 0)
  • $table->geometryCollection(string $column_name, int $srid = 0)

空间索引

您可以使用 spatialIndex 和 dropSpatialIndex Blueprint 在迁移中添加或删除空间索引。

  • $table->spatialIndex('column_name')
  • $table->dropSpatialIndex(['column_name']) 或 $table->dropSpatialIndex('index_name')

关于空间索引的说明，请参阅MySQL 文档

对于MyISAM和（自 MySQL 5.7.5 以来）InnoDB表，MySQL可以使用与创建常规索引类似的语法创建空间索引，但使用SPATIAL关键字。空间索引中的列必须声明为NOT NULL。

请参阅 Laravel 5.6 文档中的此重要说明，关于索引长度。

例如，作为快速入门的后续步骤；从命令行生成一个新的迁移

php artisan make:migration update_places_table

然后编辑您刚刚创建的迁移文件

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class UpdatePlacesTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        // MySQL < 5.7.5: table has to be MyISAM
        // \DB::statement('ALTER TABLE places ENGINE = MyISAM');

        Schema::table('places', function (Blueprint $table) {
            // Make sure point is not nullable
            $table->point('location')->change();
          
            // Add a spatial index on the location field
            $table->spatialIndex('location');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('places', function (Blueprint $table) {
            $table->dropSpatialIndex(['location']); // either an array of column names or the index name
        });

        // \DB::statement('ALTER TABLE places ENGINE = InnoDB');

        Schema::table('places', function (Blueprint $table) {
            $table->point('location')->nullable()->change();
        });
    }
}

测试

$ composer test
# or 
$ composer test:unit
$ composer test:integration

集成测试需要一个运行的 MySQL 数据库。如果您已安装 Docker，可以轻松启动一个

$ make start_db		# starts MySQL 8.0
# or
$ make start_db V=5.7	# starts MySQL 5.7

贡献

欢迎提出建议和拉取请求！带测试的拉取请求是最好的！还有很多 MySQL 空间函数要实现或创造性地使用空间函数的方法。

致谢

最初受到njbarrett 的 Laravel postgis 包的启发。