IPinfo Laravel 客户端库使用教程

IPinfo Laravel 客户端库使用教程

laravel Official Laravel client library for IPinfo API (IP geolocation and other types of IP data) 项目地址: https://gitcode.com/gh_mirrors/laravel7/laravel

1. 项目目录结构及介绍

IPinfo Laravel 客户端库的目录结构如下：

ipinfo/laravel/
├── config/
│   └── ipinfo.php
├── src/
│   ├── IPinfoServiceProvider.php
│   ├── IPinfo.php
│   └── ...
├── test/
│   └── ...
├── .gitignore
├── .styleci.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── composer.json
├── phpunit.xml
├── psalm.xml
├── rewriteRules.php
└── rules.php

目录结构说明：

• config/: 包含项目的配置文件 ipinfo.php，用于设置 IPinfo API 的访问令牌和其他配置选项。
• src/: 包含项目的源代码，包括服务提供者 IPinfoServiceProvider.php 和主要的 IPinfo 类 IPinfo.php。
• test/: 包含项目的测试代码。
• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被版本控制。
• .styleci.yml: 代码风格检查配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• composer.json: Composer 依赖管理文件。
• phpunit.xml: PHPUnit 测试配置文件。
• psalm.xml: Psalm 静态分析配置文件。
• rewriteRules.php: 重写规则文件。
• rules.php: 规则文件。

2. 项目启动文件介绍

在 Laravel 项目中，IPinfo 客户端库的启动文件主要是 IPinfoServiceProvider.php。这个文件位于 src/ 目录下，负责注册和启动 IPinfo 服务。

IPinfoServiceProvider.php

namespace ipinfo\ipinfolaravel;

use Illuminate\Support\ServiceProvider;

class IPinfoServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // 加载配置文件
        $this->publishes([
            __DIR__.'/../config/ipinfo.php' => config_path('ipinfo.php'),
        ]);

        // 注册中间件
        $this->app['router']->aliasMiddleware('ipinfo', IPinfoMiddleware::class);
    }

    public function register()
    {
        // 绑定 IPinfo 服务
        $this->app->singleton('ipinfo', function ($app) {
            return new IPinfo($app['config']['ipinfo']);
        });
    }
}

启动文件说明：

• boot(): 加载配置文件并注册中间件。
• register(): 绑定 IPinfo 服务到应用程序容器中。

3. 项目配置文件介绍

IPinfo Laravel 客户端库的配置文件位于 config/ 目录下，文件名为 ipinfo.php。这个文件用于配置 IPinfo API 的访问令牌和其他选项。

config/ipinfo.php

return [
    'access_token' => env('IPINFO_SECRET', null),
    'cache_maxsize' => 4096,
    'cache_ttl' => 1440,
    'ip_selector' => new DefaultIPSelector(),
    'countries_file' => null,
    'filter' => true,
];

配置文件说明：

• access_token: IPinfo API 的访问令牌，可以通过环境变量 IPINFO_SECRET 设置。
• cache_maxsize: 缓存的最大大小，默认为 4096。
• cache_ttl: 缓存的生存时间，默认为 1440 分钟（24 小时）。
• ip_selector: IP 选择器，默认为 DefaultIPSelector，可以选择 OriginatingIPSelector 或其他自定义选择器。
• countries_file: 自定义国家名称文件路径，用于国际化。
• filter: 是否过滤掉带有 "bot" 或 "spider" 的请求，默认为 true。

通过以上配置，您可以灵活地调整 IPinfo Laravel 客户端库的行为，以满足您的具体需求。

laravel Official Laravel client library for IPinfo API (IP geolocation and other types of IP data) 项目地址: https://gitcode.com/gh_mirrors/laravel7/laravel