Summary

This project, zl-backend, provides an enterprise-grade backend foundation scaffold built upon Spring Boot. It targets developers needing to rapidly construct scalable and maintainable enterprise applications. The scaffold offers a modular design, comprehensive security features, multi-module management, and extensive extensibility, significantly accelerating new project development.

How It Works

The framework employs a modular architecture with core components like zl-common, zl-framework, zl-security, and zl-web, alongside extensible modules in zl-extend. It leverages Spring Boot 3.4.5, MyBatis, Spring Security with JWT for authentication, and integrates features like AOP for operation logging and idempotency control, and Jackson for data masking. Its design prioritizes scalability and maintainability through clear separation of concerns and reusable components.

Quick Start & Requirements

• Primary install/run command: Build with mvn clean package and run the application using java -jar zl-web/target/zl-web-1.0-SNAPSHOT.jar.
• Prerequisites: JDK 17+, Maven 3.6+, MySQL 8.0+, Redis 6.0+.
• Documentation: API documentation is available at http://localhost:8080/doc.html post-startup. A visual code generator is accessible at http://localhost:8080/generator.html.

Highlighted Details

• Code Generator V2.0: A visual tool supporting single, master-detail, and tree table generation with intelligent field recognition and code preview.
• Security Features: JWT-based authentication, RBAC authorization, email verification for registration and password reset, and secure password storage (BCrypt).
• Extensibility: Modules for file storage (MinIO with chunking/resumption), system monitoring (OSHI), AI integration (Spring AI, LangChain4j), distributed task scheduling (XXL-JOB), message queues (RabbitMQ), and IoT (EMQ MQTT).
• Core Utilities: Includes AOP-based operation logging, idempotency control, data masking, global exception handling, and unified API response formats.

Maintenance & Community

The project is actively developed, with feedback encouraged via the Issues section on its repository. Specific details on maintainers, sponsorships, or community channels like Discord/Slack are not provided in the README.

Licensing & Compatibility

The license type is not specified in the provided documentation. This absence requires further investigation for commercial use or integration into closed-source projects.

Limitations & Caveats

The project is described as being in continuous development, implying ongoing updates and potential for breaking changes. Default credentials and keys must be changed for production environments, and certain extended features necessitate configuration of external services like MinIO or RabbitMQ.