分享每一天-打造自己webman基础插件PHP插件包

打造自己webman基础插件PHP插件包

PHP 1423 0 创建时间：2024-01-05 10:37:15

webman php 插件包

### 基础插件是什么？

基础插件是一些通用组件，一般使用composer安装，代码放置于`vendor`下。安装的时候可以将一些自定义的配置(中间件、进程、路由等配置)自动拷贝到`{主项目}config/plugin`目录下，`webman`会自动识别该目录配置并将配置合并到主配置当中，从而让插件可以介入到webman的任何生命周期当中。

### 编写插件

### 1、安装webman框架

```auto
composer create-project workerman/webman webman2024
```

### 2、安装 console命令行

```auto
composer require webman/console
```

`webman/console` 是一个webman命令行工具，更多了解请参考这里：https://www.workerman.net/plugin/1

### 3、创建插件

这里以创建一个`tinywan/encryption`插件，以AES高级加密标准为准，**主要场景适用于和其他语言进行加解和解密**。

> > AES 全称为 Advanced Encryption Standard，即高级加密标准，是一种常用密钥加密的块算法。这个标准用来替代原先的DES（Data Encryption Standard），已经被多方分析且广为全世界所使用。

> 注意：
> 
> 1.  插件名由两部分组成，`厂商名`和`插件名`，例如这里厂商名是`tinywan`，插件名是`encryption`。
>     
> 2.  `厂商名`和`插件名`是后面composer要发布的项目名，名称需要小写。
>

#### 创建插件命令

```auto
php webman plugin:create --name=tinywan/encryption
```

创建插件后会生成目录 `vendor/tinywan/encryption` 用于存放插件相关文件 和 `config/plugin/tinywan/encryption` 用于存放插件相关配置。

> `vendor/tinywan/encryption` 目录结构

```auto
├── vendor
│   ├── autoload.php
│   ├── tinywan
│   │   └── encryption
│   │       ├── composer.json
│   │       └── src
```

> `config/plugin/foo/admin` 目录结构

```auto
.
├── app
│   ├── plugin
│   │   ├── tinywan
│   │   │   └── encryption
│   │   │       └── app.php
```

配置文件说明

-   `app.php` 主配置文件
    
-   `bootstrap.php` 进程启动配置文件
    
-   `route.php` 路由配置文件
    
-   `middleware.php` 中间件配置文件
    
-   `process.php` 自定义进程配置文件
    
-   `database.php` 数据库配置文件
    
-   `redis.php` redis配置文件
    
-   `thinkorm.php` thinkorm 数据库配置文件
    
-   `database.php` 数据库配置文件

配置格式与webman相同，这些配置会自动被webman识别合并到配置当中。使用时以 plugin 为前缀访问，例如 `config('plugin.tinywan.encryption.app')`;

### 4、开发插件

开发插件在插件的生成目录`vendor/tinywan/encryption`下进行编写。由于开发该插件需要借助于openssl扩展，所以需要在`composer.json`配置文件指定一下依赖`"ext-openssl": "*"`同时限制安装该扩展包PHP版本必须大于等于`7.4`

最终`composer.json`内容如下

```auto
{
  "name": "tinywan/encryption",
  "type": "library",
  "license": "MIT",
  "description": "Webman plugin tinywan/encryption",
  "require": {
    "php": "^7.4",
    "ext-openssl": "*"
  },
  "autoload": {
    "psr-4": {
      "Tinywan\\Encryption\\": "src"
    }
  }
}
```

加解密主文件`Encryption.php`编写，注意该文件需要的`vendor/tinywan/encryption/src`目录下进行编写

`Encryption.php`文件

```auto
<?php
/**
 * @desc Encryption
 * @author Tinywan(ShaoBo Wan)
 * @date 2024/1/4 9:28
 */

declare(strict_types=1);

namespace Tinywan\Encryption;

class Encryption
{
    /** AES-128-ECB 加密方式*/
    public const AES_128_ECB = 'AES-128-ECB';

/**
     * @desc 加密
     * @param string $data 加密的数据
     * @param string $key 密钥，必须是16、24或32个字符长度
     * @param string $algo 加密方式
     * @param string $iv 初始向量（IV）
     * @return string
     * @author Tinywan(ShaoBo Wan)
     */
    public static function encrypt(string $data, string $key, string $algo = self::AES_128_ECB, string $iv = ''): string
    {
        $encryptedBytes = openssl_encrypt($data, $algo, $key, OPENSSL_RAW_DATA);
        return base64_encode($encryptedBytes);
    }

/**
     * @desc 解密
     * @param string $data
     * @param string $key 密钥，必须是16、24或32个字符长度
     * @param string $algo 加密方式
     * @param string $iv 初始向量（IV）
     * @return false|string
     * @author Tinywan(ShaoBo Wan)
     */
    public static function decrypt(string $data, string $key, string $algo = self::AES_128_ECB, string $iv = '')
    {
        return openssl_decrypt(base64_decode($data), $algo, $key, OPENSSL_RAW_DATA);
    }
}
```

> 注：以上的命名空间需要和`composer.json`的`psr-4`命名空间保持一致

### 5、导出插件

当开发完插件后，执行以下命令导出插件

```auto
php webman plugin:export --name=tinywan/encryption
```

输出以下内容

```auto
Export Plugin
Create /home/www/build/webman2024/vendor/tinywan/encryption/src/Install.php
Copy config/plugin/tinywan/encryption to /home/www/build/webman2024/vendor/tinywan/encryption/src/config/plugin/tinywan/encryption 
Saved tinywan/encryption to /home/www/build/webman2024/vendor/tinywan/encryption
```

> 导出说明
> 
> 1.  导出后会将`config/plugin/tinywan/encryption`目录拷贝到`vendor/tinywan/encryption/src`下，同时自动生成一个`Install.php`，`Install.php`用于自动安装和自动卸载时执行一些操作。
>     
> 2.  安装默认操作是将`vendor/tinywan/encryption/src` 下的配置拷贝到当前项目`config/plugin`下
>     
> 3.  移除时默认操作是将 当前项目`config/plugin`下的配置文件删除
>     
> 4.  你可以修改`Install.php`以便在安装和卸载插件时做一些自定义操作。
>

导出后的目录结构

```auto
vendor
├── autoload.php
├── tinywan
│   └── encryption
│       ├── composer.json
│       └── src
│           ├── config
│           │   └── plugin
│           │       └── tinywan
│           │           └── encryption
│           │               └── app.php
│           ├── Encryption.php
│           └── Install.php
```

### 6、发布插件

这里发布插件，就是把基础插件包通过Composer发布到官方仓库。更多了解：[如何发布一个自己的Composer依赖包](https://mp.weixin.qq.com/s?__biz=MzUzMDMxNTQ4Nw==&mid=2247488688&idx=1&sn=b81f71d85b5e88910483a5c0c59b0263&scene=21#wechat_redirect)

> Composer是 用PHP开发的用来管理项目依赖的工具，当你在项目中声明了依赖关系后，composer可以自动帮你下载和安装这些依赖库，并实现自动加载代码。

1.  Github 新建一个公共仓库`encryption`
    
2.  推送本地基础插件包到远程仓库

```auto
cd webman2024/vendor/tinywan/encryption

echo "# ddd" >> README.md
git init
git add ./
git commit -m "first commit"
git branch -M main
git remote add origin git@github.com:Tinywan/encryption.git
git push -u origin main
```

3.  登录https://packagist.org/ 提交插件包

> 注：提交地址为Github仓库地址

4.  在自己的代码仓库`https://github.com/Tinywan/encryption/releases/new`发布一个`releases`如 `v1.0.0`

重新查看`https://packagist.org/packages/tinywan/encryption`页面点击 `Update` 按钮更新版本，可以看到刚才发布的`v1.0.0`的版本已经更新到官方仓库了
 
### 7、使用插件

使用基础插件就是可以正常使用composer包一样简单喔！

安装

```auto
composer require tinywan/encryption
```

使用

```auto
require __DIR__ . '/../vendor/autoload.php';

$key = '4d7f2e7fe8e450385253bf379b13e432';

$encrypt = \Tinywan\Encryption\Encryption::encrypt('开源技术',$key);
echo '加密结果：'.$encrypt. PHP_EOL;

$decrypt = \Tinywan\Encryption\Encryption::decrypt($encrypt,$key);
echo '解密结果：'.$decrypt. PHP_EOL;
```

打造自己webman基础插件PHP插件包

商品推荐

广告推荐

推荐文章