tiny-engine-backend-java

English | 简体中文

Local Boot Steps:

• Click the Fork button in the upper right corner of the tiny-engine-backend-java repository to fork the upstream repository to your personal repository
• Clone personal warehouse to local
• The installation depends on JDK 1.8 and Maven 3.5 or later
• Modify the configuration of the connection database in the tiny-engine-backend-java/app/src/main/resources/application-dev.yml file
• Start the project in tiny-engine-backend-java/app/src/main/java/com/tinyengine/it/TinyEngineApplication for local development

For details, please refer to TinyEngine Official Website - User Manual - Platform Development Guide - Local Startup Joint Debugging of Front-end and Backend Codes.

Directory Rules

Before development, you need to understand the overall directory structure of the project and compile code according to the following rules

├── README.md
├── app                                                            // Basic services
│   └── src                      
│       └── main 
│           └── java 
│               ├── com.tinyengine.it
│               │            ├── config                           // Profiles
│               │            └── TinyEngineApplication            // Startup class, main entrance
│               └── resource 
│                      ├── sql                                    // SQL files, including table creation files and SQL files of basic data
│                      │   ├── h2                                 
│                      │   ├──mysql                               
│                      │   └──postgresql                          
│                      └── application.yml
│                      
│                                                                // Configuration information, some of the configurations that are mainly used to manage the Springboot application globally, some configurations related to MybatisPlus, etc
└── base                                                         // Business function services
    └── src 
        ├── main                    
        │   └── java          
        │       └── com
        │           └── tinyengine
        │               └── it
        │                   ├── common                            // Public Documents   
        │                   │   ├── base                          // Public entity classes
        │                   │   │   └── BaseEntity                
        │                   │   ├── enums                         // Public enumeration classes
        │                   │   │   └── Enums                     
        │                   │   ├── exception                     // Public anomaly classes
        │                   │   │   └── ExceptionEnum             
        │                   │   ├── handler                       // Data type processor
        │                   │   │   └── ListTypeHandler           
        │                   │   ├── log                           // System logs
        │                   │   │   └── SystemControllerLog       
        │                   │   └── utils                         // Utilities
        │                   │       └── Utils                     
        │                   ├── config                            // Configure the class
        │                   │   └── AiChatConfig                      
        │                   ├── controller                        // Business control layer
        │                   │   └── AppController                 
        │                   ├── gateway                           // gateway
        │                   │   └── ai
        │                   │       └── AiChatClient                  
        │                   ├── mapper                            // Data access layer
        │                   │   └── AppMapper                     
        │                   ├── model                             // Model entity class
        │                   │   ├── dto
        │                   │   │   └── BlockDto                  
        │                   │   └── entity
        │                   │       └── Block                     
        │                   └── service                           // Business logic layer
        │                       ├── app                           // app module
        │                       │   ├── impl                      // APP module business implementation class
        │                       │   │   └── AppServiceImpl        
        │                       │   └── AppService                // Business logic interface of the app module
        │                       ├── material                      // Material module
        │                       │   ├── impl                      // The business implementation class of the material module
        │                       │   │   └── BlockServiceImpl      
        │                       │   └── BlockService              // Taking blocks as an example, this layer is the business logic interface related to the material
        │                       └── platform                      // Designer module
        │                           ├── impl                      // The business implementation class of the designer module
        │                           │   └── PlatformServiceImpl   
        │                           └── PlatformService           // The business logic interface of the designer module
        └── test                                                  // The test directory is divided into test cases of different modules according to the above directory                 
            ├── java
            │    └── com 
            │        └── tinyengine
            │            └── it
            │                ├── common
            │                │   ├── base
            │                │   │   └── ResultTest
            │                │   ├── exception
            │                │   │   └── GlobalExceptionAdviceTest
            │                │   ├── handler
            │                │   │   └── ListTypeHandlerTest
            │                │   ├── log
            │                │   │   └── SystemLogAspectTest
            │                │   └── utils
            │                │       └── UtilsTest
            │                ├── controller
            │                │   └── AppControllerTest
            │                ├── gateway
            │                │   └── ai
            │                │       └── AiChatClientTest
            │                ├── mapper
            │                │   └── AppMapperTest
            │                └── service     
            │                    ├── app
            │                    │   └── impl
            │                    │       └── AppServiceImplTest
            │                    ├── material
            │                    │   └── impl
            │                    │       └── BlockServiceImplTest
            │                    └── platform
            │                        └── impl        
            │                            └── PlatformServiceImplTest              
            └── resources                    

Interface Return Specifications

1.Return Format

• Correct data

{
        "data": {
        "id": 1,
        "createdBy": "1"
        }
        "code": "200",
        "message": "操作成功",
        "error": null,
        "errMsg": null,
        "success": true
        }

• Error Data

{
        "data": null,
        "code": "CM003",
        "message": "重复创建，请修改传入参数。",
        "error": {
        "code": "CM003",
        "message": "重复创建，请修改传入参数。"
        },
        "errMsg": "重复创建，请修改传入参数。",
        "success": false
        }

Manual

For more information about how to use the server, please refer to TinyEngine Official Website - User Manual - Platform Development Guide

Local Runtime Configuration:

JDK1.8， Maven 3.5 or later is sufficient， mysql 8

Database table mapping before and after data migration

• Blocks -------> historical association changes in blocks: After being refactored by the blocks__histories of nodejs, ref_id the block table associated with this property is directly added to the t_block_history table of the Java database, and there is no need to blocks__histories the associated table

• Material -------> block association changes: The block-history_id field in the material block history relationship table of the block_histories_materials__materials_user_blocks of nodejs is used to find the primary key of the block in the block_id block_histories table, and then the block information is found in the block table through the block_id, in order to query more conveniently. In the Java database table, the relationship table between blocks and materials is directly created r_material_block

Summarizing the changes in the database table can be roughly divided into the following types

• The definition of the field in the database table is more standardized, and the previous hump is changed to an underscore name, such as isDefault -> is_default
• The meaning of the definition of the database table field is clearer, such as app -> app_id, created_at -> created_time
• Most of the database tables have new tenant_id, site_id, renter_id, and platform_id fields, as well as designer tables t_platform and designer history tables t_platform_history due to tenant isolation
• The database table relationship is clearer and clearer, and some useless table relationships are deleted, such as the table relationship between the block and the block history, which is directly t_block_history added to the block history table, that is, the ref_id as a foreign key
• The block_categories block classification was deleted, and the block grouping and classification were merged into a block grouping, taking into account the similar functions and functions of grouping and classification
• The t_business_category of the business classification table and the relationship table between the material and the business classification are reserved, and r_material_category

nodejs database tables	Java database tables	New attributes	Delete the attribute	Modify the attributes
app_extensions	t_app_extension	tenant_id、site_id、renter_id