Laravel HashSlug 项目教程

1、项目的目录结构及介绍

Laravel HashSlug 项目的目录结构如下：

laravel-hashslug/
├── config/
│   └── hashslug.php
├── src/
│   ├── HashSlug.php
│   └── HashSlugServiceProvider.php
├── tests/
│   └── HashSlugTest.php
├── .gitignore
├── LICENSE
├── README.md
├── composer.json
├── composer.lock
└── phpunit.xml

目录结构介绍

• config/：包含项目的配置文件 hashslug.php。
• src/：包含项目的主要源代码文件，包括 HashSlug.php 和 HashSlugServiceProvider.php。
• tests/：包含项目的测试文件 HashSlugTest.php。
• .gitignore：Git 忽略文件。
• LICENSE：项目的许可证文件。
• README.md：项目的说明文档。
• composer.json 和 composer.lock：Composer 依赖管理文件。
• phpunit.xml：PHPUnit 测试配置文件。

2、项目的启动文件介绍

项目的启动文件主要包括 HashSlugServiceProvider.php 和 HashSlug.php。

HashSlugServiceProvider.php

HashSlugServiceProvider.php 是 Laravel 服务提供者文件，负责注册和启动 HashSlug 服务。

namespace Afiqiqmal\LaraHashSlug;

use Illuminate\Support\ServiceProvider;

class HashSlugServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->publishes([
            __DIR__.'/../config/hashslug.php' => config_path('hashslug.php'),
        ]);
    }

    public function register()
    {
        $this->mergeConfigFrom(
            __DIR__.'/../config/hashslug.php', 'hashslug'
        );
    }
}

HashSlug.php

HashSlug.php 是 HashSlug 的核心逻辑文件，负责生成和解析 HashSlug。

namespace Afiqiqmal\LaraHashSlug;

use Hashids\Hashids;

class HashSlug
{
    protected $hashids;

    public function __construct()
    {
        $this->hashids = new Hashids(
            config('hashslug.salt'),
            config('hashslug.length'),
            config('hashslug.alphabet')
        );
    }

    public function encode($id)
    {
        return $this->hashids->encode($id);
    }

    public function decode($hash)
    {
        $decoded = $this->hashids->decode($hash);
        return $decoded ? $decoded[0] : null;
    }
}

3、项目的配置文件介绍

项目的配置文件位于 config/hashslug.php，包含了 HashSlug 的默认配置。

hashslug.php

return [
    'salt' => env('HASHID_SALT', 'lara-hash-slug'),
    'length' => env('HASHID_LENGTH', 12),
    'alphabet' => env('HASHID_ALPHABET', 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'),
    'unique' => env('HASHID_UNIQUE', true),
];

配置项介绍

• salt：用于生成 HashSlug 的盐值，默认值为 lara-hash-slug。
• length：生成的 HashSlug 的长度，默认值为 12。
• alphabet：用于生成 HashSlug 的字符集，默认值为 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890。
• unique：是否生成唯一的 HashSlug，默认值为 true。

通过以上配置，可以灵活地调整 HashSlug 的生成规则。