[Improvement] MyBatis-Plus Enum Refactoring Implementation Plan

[GOODBOY008]

🚀 Enum Refactoring Plan Discussion

Hi team! I've created a comprehensive refactoring plan for migrating to MyBatis-Plus automatic enum conversion using @EnumValue annotations. This will improve maintainability and consistency across the codebase.

📋 Migration Overview

Goal: Leverage MyBatis-Plus's automatic enum conversion by using @EnumValue annotation for better maintainability and consistency.

📊 Analysis Summary

Phase 1: Enums in streampark-common (12 enums to refactor)

• ApplicationType.java → Annotate type (int)
• ClusterState.java → Annotate state (Integer)
• FlinkDeployMode.java → Annotate mode (Integer)
• FlinkJobType.java → Annotate mode (Integer)
• FlinkK8sRestExposedType.java → Annotate type (Integer)
• FlinkRestoreMode.java → Annotate mode (int)
• FlinkSqlValidationFailedType.java → Annotate failedType (int)
• ResolveOrder.java → Annotate order (Integer)
• SparkDeployMode.java → Annotate mode (Integer)
• SparkJobType.java → Annotate mode (Integer)
• SparkSqlValidationFailedType.java → Annotate failedType (int)
• StorageType.java → Annotate type (String)

Phase 2: Enums in streampark-console (~25 enums to refactor)

Including: AccessTokenStateEnum, AlertTypeEnum, AppExistsStateEnum, AuthenticationType, BuildStateEnum, etc.

Note: Some enums already have @EnumValue annotation and just need verification.

🎯 Implementation Strategy

1. Apply @EnumValue annotations to identified enum fields
2. Refactor entity classes to use enum types directly instead of primitive values
3. Update mapper interfaces and remove manual conversion logic
4. Configure Jackson globally for consistent enum serialization to frontend

🧪 Testing & Verification Plan

• Unit tests for enum value mapping
• Integration tests for database persistence
• Full build verification: mvn clean install
• Existing test suite validation

🔧 Frontend Serialization (Bonus)

Recommend global Jackson configuration:

@Bean
public Jackson2ObjectMapperBuilderCustomizer customizer() {
    return builder -> builder.featuresToEnable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);
}

🤝 Next Steps

I'm ready to begin implementation following community feedback. Please let me know:

• Your thoughts on the approach
• Any concerns or suggestions
• Preferred implementation order
• Review preferences

Looking forward to your feedback! 🙌

Reference: MyBatis-Plus Official Docs - Auto Enum Conversion

[wolfboys]

Good proposal 🙌