How birdlark/larkmidtable works
Major Components
• Frontend/UI Layer: This is represented by the “larkmidtable-ui” directory. It is a single-page application (likely built with Vue.js) that provides all the visual interfaces (dashboards, login pages, data visualizations, etc.).
• Backend/Web Layer: This is primarily encapsulated in “larkmidtable-web” which is divided into submodules. In particular:
– The “larkmt-admin” module (Java-based with Spring and MyBatis) handles administrative functions, APIs, authentication/authorization, controller logic, and integration with business services.
– The “larkmt-core” module implements core business logic, service orchestration, and common utilities.
– The “larkmt-rpc” module provides remote procedure call infrastructure for communication between services (using strategies like load balancing, serialization, etc.).
• Documentation: The “larkmidtable-doc” directory holds various guides (user manual, developer notes, plugin development, etc.) that support both system understanding and eventual integrations.
• External Systems and Connectors: As noted in the README’s “产品技术选型” (Product Technical Selection) section, external systems include data warehouse components (clickhouse/doris), message brokers (Kafka), integration tools (datax/flinkx), stream processing (flink, flinkcdc, seatunnel), monitoring (prometheus), additional UI visualization (datart), and more. Although these do not appear as file submodules, they are important parts of the overall ecosystem.
Determining Relationships and Data Flow
• The “larkmt-core” module encapsulates core business handlers (job execution, scheduling, authorization, etc.) and interacts with the data layer (via MyBatis mappers and configuration files in “larkmt-admin/src/main/resources”). Show these as database symbols or data stores.
• Finally, indicate the external data services and big data components (clickhouse, doris, Kafka, etc.) as separate blocks communicating with the backend through connectors.
Architectural Patterns and Design Principles
• Modular Architecture: The split into UI, admin, core, and RPC modules reflects clear separation of concerns.
What
• Each major component as identified:
– Frontend (larkmidtable-ui)
– Backend’s administrative API/service layer (larkmt-admin)
– Business logic and core services (larkmt-core)
– RPC communication layer (larkmt-rpc)
– External Systems (clickhouse/doris, Kafka, data integration tools, etc.)
• Clear labels and descriptive titles for each component.
– From the UI to the admin controllers.
– From the admin controllers to core business services.
– Between core services and the RPC layer (if distributed calls are involved).
– Outbound from core services to external systems (databases, messaging systems, etc.).
• Annotations identifying key configurations (e.g., “pom.xml” indicates Maven-managed builds, “application.yml” for configuration, and “mybatis-mapper” for ORM mappings).