Hertz Examples

The hertz_session demo demonstrates a distributed session solution using hertz-contrib/sessions. This approach stores sessions in Redis (or a Redis cluster) to ensure session synchronization across multiple servers in a distributed system.

Key technologies used in this demo:

• Session Management: hertz-contrib/sessions for distributed sessions.
• Security: hertz-contrib/csrf to prevent Cross-Site Request Forgery attacks.
• Interface Definition: thrift IDL to define HTTP interfaces.
• Code Generation: hz toolkit to generate Hertz code from IDL.
• Database: Gorm with MySQL for data persistence.
• Frontend: AdminLTE for login and registration pages.

The tiktok_demo is a Hertz server providing backend services for a TikTok-like application. It includes the following functional services:

The hertz_gorm project is a demonstration of integrating the Hertz web framework with Gorm (an ORM) and MySQL. It showcases a complete workflow including:

• Defining HTTP interfaces using thrift IDL.
• Generating code using the hz toolkit.
• Implementing request binding and validation using Hertz features.
• Performing database operations with Gorm and MySQL.

The hertz_swagger_gen example demonstrates how to build a web service using Hertz with automated Swagger documentation generation.

Key features demonstrated:

• Defining HTTP interfaces using thrift IDL.
• Generating code using the hz toolkit.
• Integrating Gorm with MySQL for data persistence.
• Using the thrift-gen-http-swagger plugin to automatically generate Swagger files and host a swagger ui service.

Endpoints provided:

• /swagger: Serves the Swagger documentation and the Swagger UI interface.
• /handler: Contains core business logic for user operations: updating users, adding users, deleting users, and querying users.

The hz template is a scaffolding tool designed to generate a base project structure using the Hertz framework. It provides a standard MVC (Model-View-Controller) hierarchy and integrates several essential Hertz extensions and utilities.

Key features include:

• Hertz Framework Integration: Built on top of the Hertz web framework.
• Pre-configured Extensions: Includes pprof, cors, recovery, access_log, and gzip.
• Testing Support: Generates base code for unit tests.
• Observability: Provides basic profiling functions.
• Standardized Architecture: Implements a clean MVC code hierarchy.

Hertz supports Gzip compression middleware which can be customized to control which requests are compressed. You can configure the middleware using the following strategies:

• Default compression: Uses standard compression settings.
• Extension exclusion: Exclude specific file suffixes from being compressed (e.g., images or static assets).
• Path exclusion: Exclude specific URL paths from being compressed.
• Regex path exclusion: Use regular expressions to define complex path exclusion rules.

The hertz_jwt demo demonstrates the integration of several components:

• Hertz & JWT: Uses the hertz-contrib/jwt extension for login and authentication.
• hz: Uses the hz code generation tool to scaffold the project.
• Binding and Validate: Utilizes Hertz's built-in binding and validation features for request handling.
• Gorm & MySQL: Uses the Gorm ORM to interact with a MySQL database.

Hertz supports various communication protocols. You can find detailed guides for the following in the repository:

• http1: Instructions on how to implement and use the HTTP/1.1 protocol.
• tls: Instructions on how to use the TLS protocol and how to send TLS-encrypted requests using the Hertz client.

For a complete list of supported protocols and advanced usage, refer to the official Hertz documentation at https://www.cloudwego.io/zh/docs/hertz/tutorials/basic-feature/protocol/.

The Hertz client can be configured for various networking tasks:

• Basic Requests: Send requests with support for deadlines, redirects, and timeouts (client/send_request).
• Parameter Injection: Add query, form, path, and body parameters to requests (client/add_parameters).
• File Operations: Upload files via the client (client/upload_file).
• Streaming: Read streaming responses (client/streaming_read).
• Proxying: Configure forward proxies for client requests (client/forward_proxy).
• Middleware: Apply middleware to client-side requests (client/middleware).