{"id":33990120,"url":"https://github.com/maxlcoder/laravel-desensitization","last_synced_at":"2026-04-09T00:33:02.965Z","repository":{"id":242990676,"uuid":"811154242","full_name":"maxlcoder/laravel-desensitization","owner":"maxlcoder","description":"接口脱敏中间件","archived":false,"fork":false,"pushed_at":"2024-07-18T08:48:16.000Z","size":10,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-14T18:05:10.013Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxlcoder.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-06T03:36:20.000Z","updated_at":"2025-11-18T03:31:22.000Z","dependencies_parsed_at":"2024-06-06T04:52:48.460Z","dependency_job_id":null,"html_url":"https://github.com/maxlcoder/laravel-desensitization","commit_stats":null,"previous_names":["maxlcoder/laravel-desensitization"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/maxlcoder/laravel-desensitization","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxlcoder%2Flaravel-desensitization","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxlcoder%2Flaravel-desensitization/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxlcoder%2Flaravel-desensitization/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxlcoder%2Flaravel-desensitization/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxlcoder","download_url":"https://codeload.github.com/maxlcoder/laravel-desensitization/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxlcoder%2Flaravel-desensitization/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31580028,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-13T06:02:53.480Z","updated_at":"2026-04-09T00:33:02.956Z","avatar_url":"https://github.com/maxlcoder.png","language":"PHP","readme":"# Laravel Desensitization Middleware\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/maxlcoder/laravel-desensitization.svg?style=flat-square)](https://packagist.org/packages/maxlcoder/laravel-desensitization)\n[![Total Downloads](https://img.shields.io/packagist/dt/maxlcoder/laravel-desensitization.svg?style=flat-square)](https://packagist.org/packages/maxlcoder/laravel-desensitization)\n![GitHub Actions](https://github.com/maxlcoder/laravel-desensitization/actions/workflows/main.yml/badge.svg)\n\n[English](#english) | [简体中文](#简体中文)\n\n---\n\n## English\n\nA middleware for desensitizing API response data. It is configuration-driven and supports highly customizable processing functions (methods).\n\n### Installation\n\n```bash\ncomposer require maxlcoder/laravel-desensitization\n```\n\n### Configuration\n\nPublish configuration:\n\n```bash\nphp artisan vendor:publish --provider=\"Maxlcoder\\LaravelDesensitization\\LaravelDesensitizationServiceProvider\"\n```\n\n#### Config Fields\n\n- `functions`: Global helper function mapping. Example: `'mobile' =\u003e 'desensitiseMobile'` means fields with `type=mobile` in `uris` will use this helper.\n- `class`: Global custom handler class config. `name` is the full class path (string), and `functions` maps field type to class method.\n- Priority: `functions` has higher priority. If not found, it falls back to `class`. If both are missing, no processing is applied and an error log is recorded.\n- `uris`: Defines APIs and field paths to process with corresponding types. The middleware parses response structure and iterates fields. Use `*` for array items.\n\n```php\n[\n    'functions' =\u003e [\n        'mobile' =\u003e 'desensitise_mobile',\n        'name' =\u003e 'desensitise_name'\n    ],\n    'class' =\u003e [\n        'name' =\u003e 'App\\Lib\\Desensitization',\n        'functions' =\u003e [\n            'mobile' =\u003e 'desensitiseMobile',\n        ],\n    ],\n    'uris' =\u003e [\n        'admin/admins' =\u003e [\n            ['key' =\u003e 'data.data.*.mobile', 'type' =\u003e 'mobile'],\n            ['key' =\u003e 'data.data.*.name', 'type' =\u003e 'name'],\n        ],\n    ],\n];\n```\n\n### Usage\n\nRegister middleware in `Kernel.php`:\n\n```php\nprotected $routeMiddleware = [\n    // ...\n    'desensitization' =\u003e \\Maxlcoder\\LaravelDesensitization\\Http\\Middleware\\Desensitization::class,\n];\n```\n\n### Example\n\n#### 1) Original Response\n\n```json\n{\n    \"code\": 200,\n    \"msg\": \"success\",\n    \"data\": {\n        \"mobile\": \"18900000001\",\n        \"contacts\": [\n            {\n                \"name\": \"王组闲\",\n                \"mobile\": \"18900000002\"\n            }\n        ]\n    }\n}\n```\n\n#### 2) Config\n\nEdit `config/laravel-desensitization.php`:\n\n```php\n\u003c?php\n\n/*\n * You can place your custom package configuration in here.\n *\n */\nreturn [\n    'functions' =\u003e [\n\n    ],\n    'class' =\u003e [\n        'name' =\u003e 'App\\Lib\\Desensitization',\n        'functions' =\u003e [\n            'name' =\u003e 'desensitiseRealName',\n            'mobile' =\u003e 'desensitiseMobile'\n        ],\n    ],\n    'uris' =\u003e [\n        'admin/admins' =\u003e [\n            ['key' =\u003e 'data.mobile', 'type' =\u003e 'mobile'],\n            ['key' =\u003e 'data.contacts.*.name', 'type' =\u003e 'name'],\n            ['key' =\u003e 'data.contacts.*.mobile', 'type' =\u003e 'mobile'],\n        ],\n    ],\n];\n```\n\nCustom handler class `Desensitization.php` example:\n\n```php\n\u003c?php\n\nnamespace App\\Lib;\n\nuse Illuminate\\Support\\Str;\n\nclass Desensitization\n{\n    public static function desensitiseMobile($mobile)\n    {\n        return mb_substr($mobile, 0, 3) . '****' . mb_substr($mobile, 7, 4);\n    }\n\n    public static function desensitiseName($name)\n    {\n        return Str::mask($name, '*', 0, 1);\n    }\n}\n```\n\n#### 3) Processed Response\n\n```json\n{\n    \"code\": 200,\n    \"msg\": \"success\",\n    \"data\": {\n        \"mobile\": \"189****0001\",\n        \"contacts\": [\n            {\n                \"name\": \"*组闲\",\n                \"mobile\": \"189****0002\"\n            }\n        ]\n    }\n}\n```\n\n### Testing\n\n```bash\ncomposer test\n```\n\n### Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n### Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n### Security\n\nIf you discover any security-related issues, please email liurenlin77@gmail.com instead of using the issue tracker.\n\n### Credits\n\n- [Woody](https://github.com/maxlcoder)\n- [All Contributors](../../contributors)\n\n### License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n### Laravel Package Boilerplate\n\nThis package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).\n\n---\n\n## 简体中文\n\n一个用于 API 返回数据脱敏的中间件，采用配置驱动方式，支持高度自定义处理函数（方法）。\n\n### 安装\n\n```bash\ncomposer require maxlcoder/laravel-desensitization\n```\n\n### 配置\n\n发布配置文件：\n\n```bash\nphp artisan vendor:publish --provider=\"Maxlcoder\\LaravelDesensitization\\LaravelDesensitizationServiceProvider\"\n```\n\n#### 配置字段说明\n\n- `functions`：全局辅助函数映射，例如 `'mobile' =\u003e 'desensitiseMobile'`，表示对 `uris` 中 `type=mobile` 的字段调用该函数。\n- `class`：全局自定义处理类配置。`name` 为类全路径字符串，`functions` 为类型与类方法的映射。\n- 优先级：优先使用 `functions`；若不存在再使用 `class`；若都未配置则不处理并记录 error 日志。\n- `uris`：指定需要处理的接口及字段路径和处理类型。系统会解析返回结构并迭代处理，数组使用 `*` 表示。\n\n```php\n[\n    'functions' =\u003e [\n        'mobile' =\u003e 'desensitise_mobile',\n        'name' =\u003e 'desensitise_name'\n    ],\n    'class' =\u003e [\n        'name' =\u003e 'App\\Lib\\Desensitization',\n        'functions' =\u003e [\n            'mobile' =\u003e 'desensitiseMobile',\n        ],\n    ],\n    'uris' =\u003e [\n        'admin/admins' =\u003e [\n            ['key' =\u003e 'data.data.*.mobile', 'type' =\u003e 'mobile'],\n            ['key' =\u003e 'data.data.*.name', 'type' =\u003e 'name'],\n        ],\n    ],\n];\n```\n\n### 使用方法\n\n在 `Kernel.php` 中注册中间件：\n\n```php\nprotected $routeMiddleware = [\n    // ...\n    'desensitization' =\u003e \\Maxlcoder\\LaravelDesensitization\\Http\\Middleware\\Desensitization::class,\n];\n```\n\n### 示例\n\n#### 1) 处理前返回\n\n```json\n{\n    \"code\": 200,\n    \"msg\": \"success\",\n    \"data\": {\n        \"mobile\": \"18900000001\",\n        \"contacts\": [\n            {\n                \"name\": \"王组闲\",\n                \"mobile\": \"18900000002\"\n            }\n        ]\n    }\n}\n```\n\n#### 2) 配置\n\n修改 `config/laravel-desensitization.php`：\n\n```php\n\u003c?php\n\n/*\n * You can place your custom package configuration in here.\n *\n */\nreturn [\n    'functions' =\u003e [\n\n    ],\n    'class' =\u003e [\n        'name' =\u003e 'App\\Lib\\Desensitization',\n        'functions' =\u003e [\n            'name' =\u003e 'desensitiseRealName',\n            'mobile' =\u003e 'desensitiseMobile'\n        ],\n    ],\n    'uris' =\u003e [\n        'admin/admins' =\u003e [\n            ['key' =\u003e 'data.mobile', 'type' =\u003e 'mobile'],\n            ['key' =\u003e 'data.contacts.*.name', 'type' =\u003e 'name'],\n            ['key' =\u003e 'data.contacts.*.mobile', 'type' =\u003e 'mobile'],\n        ],\n    ],\n];\n```\n\n自定义处理类 `Desensitization.php` 示例：\n\n```php\n\u003c?php\n\nnamespace App\\Lib;\n\nuse Illuminate\\Support\\Str;\n\nclass Desensitization\n{\n    public static function desensitiseMobile($mobile)\n    {\n        return mb_substr($mobile, 0, 3) . '****' . mb_substr($mobile, 7, 4);\n    }\n\n    public static function desensitiseName($name)\n    {\n        return Str::mask($name, '*', 0, 1);\n    }\n}\n```\n\n#### 3) 处理后返回\n\n```json\n{\n    \"code\": 200,\n    \"msg\": \"success\",\n    \"data\": {\n        \"mobile\": \"189****0001\",\n        \"contacts\": [\n            {\n                \"name\": \"*组闲\",\n                \"mobile\": \"189****0002\"\n            }\n        ]\n    }\n}\n```\n\n### 测试\n\n```bash\ncomposer test\n```\n\n### 更新日志\n\n更多更新内容请查看 [CHANGELOG](CHANGELOG.md)。\n\n### 参与贡献\n\n贡献细节请查看 [CONTRIBUTING](CONTRIBUTING.md)。\n\n### 安全\n\n如发现安全问题，请发送邮件至 liurenlin77@gmail.com，而非直接提交 issue。\n\n### 致谢\n\n- [Woody](https://github.com/maxlcoder)\n- [All Contributors](../../contributors)\n\n### 许可证\n\n本项目使用 MIT 许可证，详情请见 [License File](LICENSE.md)。\n\n### Laravel Package Boilerplate\n\n本包基于 [Laravel Package Boilerplate](https://laravelpackageboilerplate.com) 生成。\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxlcoder%2Flaravel-desensitization","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxlcoder%2Flaravel-desensitization","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxlcoder%2Flaravel-desensitization/lists"}