中文说明

🚀 The most popular and comprehensive collection of high-quality components for the Hyperf framework, providing 50+ production-ready packages to accelerate your application development.

This repository is a monorepo containing a collection of battle-tested, community-driven components that extend the Hyperf framework with additional features and integrations. Each component is independently usable and can be installed separately or as a complete suite.

• 🎯 50+ Components - Comprehensive collection covering various development needs
• 🔌 Easy Integration - Seamless integration with Hyperf 3.1+
• 📦 Modular Design - Install only what you need
• 🛡️ Production Ready - Battle-tested in production environments
• 📚 Well Documented - Comprehensive documentation in multiple languages
• 🧪 Fully Tested - High test coverage with PHPUnit and Pest
• 🌍 Multi-language - Documentation available in Chinese (Simplified, Traditional, HK) and English

• PHP >= 8.1
• Hyperf >= 3.1.0
• Swoole or Swow extension

composer require friendsofhyperf/components

You can install specific components as needed:

# Example: Install Telescope (Debug Assistant)
composer require friendsofhyperf/telescope

# Example: Install HTTP Client
composer require friendsofhyperf/http-client

# Example: Install Model Factory
composer require friendsofhyperf/model-factory --dev

After installing a component, most packages will automatically register with Hyperf through the ConfigProvider. Some components may require publishing configuration files:

php bin/hyperf.php vendor:publish friendsofhyperf/[component-name]

• telescope - Elegant debug assistant for Hyperf (requests, exceptions, SQL, Redis, etc.)
• tinker - Powerful REPL for interactive debugging
• web-tinker - Web-based Tinker interface
• ide-helper - Enhanced IDE support and autocompletion
• pretty-console - Beautiful console output formatting

• model-factory - Database model factories for testing
• model-observer - Eloquent model observers
• model-scope - Global and local query scopes
• model-hashids - Hashids integration for models
• model-morph-addon - Polymorphic relationship enhancements
• compoships - Multi-column relationships for Eloquent
• fast-paginate - High-performance pagination
• mysql-grammar-addon - MySQL grammar extensions
• trigger - MySQL trigger support

• cache - Advanced caching with multiple drivers
• lock - Distributed locking mechanisms
• redis-subscriber - Redis pub/sub subscriber

• http-client - Elegant HTTP client (Laravel-style)
• oauth2-server - OAuth2 server implementation

• notification - Multi-channel notifications
• notification-mail - Email notification channel
• notification-easysms - SMS notification via EasySMS
• mail - Email sending component
• tcp-sender - TCP message sender

• elasticsearch - Elasticsearch client integration
• telescope-elasticsearch - Elasticsearch storage for Telescope

• confd - Configuration management with confd
• config-consul - Consul configuration center

• command-signals - Signal handling for commands
• command-validation - Command input validation
• command-benchmark - Command performance benchmarking
• console-spinner - Console loading spinners

• facade - Laravel-style facades for Hyperf
• ipc-broadcaster - Inter-process communication broadcaster

• encryption - Data encryption and decryption
• purifier - HTML purification (XSS protection)
• recaptcha - Google reCAPTCHA integration
• validated-dto - Data Transfer Objects with validation
• grpc-validation - gRPC request validation

• helpers - Useful helper functions
• support - Support utilities and classes
• macros - Macro support for various classes

• sentry - Sentry error tracking integration

• amqp-job - AMQP-based job queue

• co-phpunit - Coroutine-compatible PHPUnit

• openai-client - OpenAI API client

• exception-event - Exception event handling

For detailed documentation, visit the official documentation website.

• 简体中文 (Simplified Chinese)
• 繁體中文 (Traditional Chinese)
• 香港繁體 (Hong Kong Traditional)
• English

git clone https://github.com/friendsofhyperf/components.git
cd components

composer install

# Run all tests
composer test

# Run specific test suites
composer test:unit      # Unit tests
composer test:lint      # Code style checks
composer test:types     # Type coverage analysis

# Fix code style
composer cs-fix

# Run static analysis
composer analyse

We welcome contributions from the community! Please read our Contributing Guidelines before submitting pull requests.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests and code quality checks
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

• 📖 Documentation: docs.hdj.me
• 💬 Issues: GitHub Issues
• 🐦 Twitter: @huangdijia
• 📧 Email: huangdijia@gmail.com

• GitHub
• CNB

We are grateful to all the contributors who have helped make this project better!

This project is open-sourced software licensed under the MIT License.

---

Made with ❤️ by Deeka Wong and contributors