Define domain code enums implementing CommonCode with EnumType.STRING for JPA persistence.
npx skills add https://github.com/gykk16/spring-skeleton --skill common-codes
Please help me install this Agent Skill. Skill: common-codes Source: https://github.com/gykk16/spring-skeleton/tree/main/.omc/skills/common-codes Command: npx skills add https://github.com/gykk16/spring-skeleton --skill common-codes
This Skill addresses the inconsistency and potential for errors in representing domain-specific codes within an application by establishing a standardized interface and best practices for enum definitions and JPA persistence.
CommonCode interface, providing consistent code and description access.EnumType.STRING for enums in database entities to prevent data corruption.OrderStatus enum, this Skill ensures it implements CommonCode and is correctly persisted as a string in the database, preventing issues if the enum order changes.Define a new enum for payment methods, ensuring it implements the CommonCode interface.
High-intent search queries and answers about installing and using this skill.
Using EnumType.STRING for JPA persistence prevents data corruption by storing the enum's name as a string, ensuring database records remain valid even if the enum order changes.
You standardize domain code enums by implementing a CommonCode interface, which provides a consistent contract for accessing code and description fields across all domain definitions.
Common pitfalls include using ordinal mapping which breaks when enum order changes, and missing column length specifications, both of which can cause data truncation or persistence errors.
Yes, the standardization approach covers REST Docs integration, allowing you to document the code and description fields of enums implementing the CommonCode interface in your API outputs.
The best way is to implement the CommonCode interface for your OrderStatus enum and annotate the entity field to persist as EnumType.STRING, preventing issues if the enum order changes.
gykk16Define domain-specific error codes and hierarchical exceptions in Kotlin.
Faouzi91Generate JPA entities for Spring Boot with PostgreSQL conventions.
gykk16Enforce standardized JPA entity mapping rules for base inheritance, enum strings, and associations.
giuseppe-trisciuoglioImplement Spring Data JPA persistence layers with repositories, entities, and queries.