README

安装

composer require youbuwei/ip-location
bin/hyperf.php vendor:publish youbuwei/ip-location

配置

基本配置

默认使用了纯真IP数据库，不保证数据的准确性，可自己通过其他方式获取IP地址数据。此外还对接了几个常用的服务商，可配置使用。

将IP数据文件路径配置到config/ip-location.php如下位置中：

'cz88' => [
    'db-path' => '',
]

因为获取归属地依赖于外部接口，存在不可控的风险，因此设计了一个开关，可以在无可用服务时关闭归属地服务，访问影响其他业务。

'enable' => true,

通过在 config/autoload/dependencies.php 文件中指定使用哪个接口，默认使用 \Youbuwei\IPLocation\Api\LocalLocation.php::class

<?php

declare(strict_types=1);

return [
    \Youbuwei\IPLocation\LocationApiInterface::class => \Youbuwei\IPLocation\Api\TencentLocation::class,
];

缓存

IP地址归属地在一定时间内是不变化的，因此可以缓存归属地信息，提高性能，减少接口的调用。

'cache' => [
    'enable' => true,
    'expire' => 86400,
],

对接的服务商

当前支持 ip-api 、腾讯位置服务、百度地图开放平台、高德开放平台

ip-api

ip-api.com，无需配置，使用简单，但可能间歇性的无法访问或者访问缓慢，暂时未对接 Pro 服务

'ip-api' => [
    'method' => 'GET',
    'domain' => 'http://ip-api.com',
    'uri' => '/json/',
    'lang' => 'zh-CN',
],

腾讯位置服务

使用了腾讯位置服务的IP定位接口，需要首先登录创建应用并申请一个key，如果使用授权签名的方式，还需要需要配置 secret。

'tencent' => [
    'method' => 'GET',
    'domain' => 'https://apis.map.qq.com',
    'uri' => '/ws/location/v1/ip',
    'key' => '',
    'secret' => '',
],

百度地图开放平台

百度地图配置参数ak时如果选择使用sn，需要同时配置sk，配置如下：

'baidu' => [
    'method' => 'GET',
    'domain' => 'https://api.map.baidu.com',
    'uri' => '/location/ip',
    'ak' => '',
    'sk' => '',
    'use_sn' => false,
    'coor' => '',
],

高德开放平台

'amap' => [
    'method' => 'GET',
    'domain' => 'https://restapi.amap.com',
    'uri' => '/v3/ip',
    'key' => '',
    'secret' => '',
],

自定义对接其他服务商

如果需要对接其他服务商，需要在

配置文件添加配置项，例如：

'custom' => [
    'method' => 'GET',
    'domain' => '',
    'uri' => '',
    'other' => '',
],

继承接口 \Youbuwei\IPLocation\LocationApiInterface::class

<?php

declare(strict_types=1);

namespace Youbuwei\IPLocation;

use Psr\Http\Message\RequestInterface;

interface LocationApiInterface
{
    public function makeRequest($ip): ?RequestInterface;

    public function getLocation(string $location): ?array;
}

使用

使用非常简单，配置好之后实例化 \Youbuwei\IPLocation\Location 并调用 getLocation(string $ip) 方法即可

<?php

declare(strict_types=1);

namespace App\Controller;

use Youbuwei\IPLocation\Location;

class IndexController extends AbstractController
{
    public function __construct(
        protected Location $location
    ) {}

    public function index()
    {
        $location = $this->location->getLocation('66.66.66.66');

        return [
            'location' => $location,
        ];
    }
}

License

The IPLocation Library is open-source software licensed under the MIT license.

youbuwei / ip-location

Maintainers

Details