The Best Multi-Tenant Plugin - druid-multi-tenant-starter

The Best Multi-Tenant Plugin - druid-multi-tenant-starter

Since July 16, 2024 The druid-multi-tenant-starter plugin has been released for more than two years. The introduction of this new tool marks the birth of an efficient and convenient SaaS multi-tenant management solution, providing developers with a brand new and convenient experience.

What is druid-multi-tenant-starter?

druid-multi-tenant-starter is a multi-tenant plugin based on MyBatis interceptor and alibaba Druid SQL parser. It aims to simplify multi-tenant management in SaaS (Software as a Service) platforms and offers an out-of-the-box, easy-to-configure solution, enabling developers to easily implement multi-tenant data isolation and management.

Key Features and Advantages

  1. Seamless Integration: As an out-of-the-box plugin, druid-multi-tenant-starter can be perfectly integrated with the existing MyBatis framework, avoiding cumbersome configuration and code modifications. Only a small amount of configuration is required to enable multi-tenant functionality, greatly enhancing development efficiency.

  2. Powerful SQL Parsing: Utilizing the powerful SQL parsing ability of alibaba Druid, druid-multi-tenant-starter can accurately parse and handle SQL statements, ensuring data isolation and security in the multi-tenant environment. Whether it is a query, update, or deletion operation, it can be effectively managed and controlled.

  3. Flexible Tenant Management: The plugin provides a variety of flexible tenant management strategies, allowing developers to define and adjust tenant identification methods according to actual needs. This makes it adaptable to different application scenarios and provides personalized solutions.

  4. Performance Optimization: druid-multi-tenant-starter parses SQL statements based on the alibaba Druid SQL parsing library, which is stronger in performance than a certain tenant plugin that parses SQL statements based on JSQLParser.

Usage Scenarios

  • SaaS Application Platform: druid-multi-tenant-starter is particularly suitable for SaaS platforms that need to support multiple tenants, as it can ensure the data security and isolation of different tenants and prevent data crossover and leakage.

  • Enterprise-level System: For enterprises that need to manage data of multiple business units or subsidiaries in the same system, druid-multi-tenant-starter provides an ideal solution, simplifying data management and maintenance work.

  • Data Sharing Platform: In scenarios where multi-party data sharing is required while ensuring data isolation, druid-multi-tenant-starter can effectively support the management needs of different data sources.

Support for Ignoring TenantId Strategy

  • Support skipping when there is already a tenantId field condition in the original SQL statement.
  • Support ignoring the addition of a tenantId field condition for the specified table name.
  • Support ignoring the addition of a tenantId field condition for the specified Mapper interface SQL statement.
  • Support specifying the table name to ignore the addition of a tenantId field condition in the SQL statement.
  • Support specifying the alias to ignore the addition of a tenantId field condition in the SQL statement.
  • Support tenant ID being passed in from the Mapper interface method parameter.

Quick Start

  • Introduce the following dependency in the already integrated Mybatis project.
<dependency> <groupId>io.github.osinn</groupId> <artifactId>druid-multi-tenant-starter</artifactId> <version>1.4.7</version></dependency>

Configuration

--Basic configurationmybatis:  tenant: config:# Whether to enable the multi-tenant pluginenable: true# The column name of the tenant ID in the databasetenant-id-column: tenant_id

Implement the Interface for Providing the Multi-Tenant Value

  • Need to implement the ITenantService interface to provide the value of the multi-tenant ID.
/** * Demonstration: Provide the multi-tenant ID service interface * * @author wency_cai */@Servicepublic class TenantServiceImpl implements ITenantService<Integer>{ @Override public List<Integer> getTenantIds() {  // Query the multi-tenant id of the system, and return multiple values if there are multiple.  int tenantId = 1;  return Lists.newArrayList(tenantId); }}
  • So far, the druid-multi-tenant-starter tenant plugin has been integrated.
  • In the SQL statements written in the project, there is no need to care about the tenant ID field. Just write the SQL statements as usual, and the underlying will modify the SQL statements to generate new SQL statements for execution.

Conclusion

druid-multi-tenant-starter has been running normally in the production environment for more than two years since its release. It not only simplifies the development work in the multi-tenant environment but also improves the performance and security of the system. We expect this plugin to help more developers and enterprises efficiently manage their multi-tenant systems and achieve rapid business development and success.

Project address: Click

Likes