proxy-backend-impl-workflow

Original：🇨🇳 Chinese

Translated

Proxy2.0 Java CRUD Interface Implementation Workflow: A 10-step standard process from requirement to full delivery. Use when: (1) Implementing new CRUD features for an entity, (2) Adding new API endpoints with full stack (DO/Mapper/VO/Service/Controller/SQL), (3) Following the standard implementation workflow for new business entities.

3installs

Sourcekevinqpeng/proxy-skills

Added on2026-03-13

NPX Install

npx skill4agent add kevinqpeng/proxy-skills proxy-backend-impl-workflow

SKILL.md Content (Chinese)

View Translation Comparison →

Java CRUD Interface Implementation Workflow

Follow these 10 steps to implement a complete CRUD interface for an entity.

Preparations

Confirm entity name, module name, and table name
Confirm field list (type, required status, validation rules)
Confirm function scope (create/retrieve/update/delete/import/export/batch delete)
Confirm if multi-tenant isolation is required (
```
tenant_id
```
)

Implementation Steps

Step 1: Define Error Codes

File:

xm-module-{module}/.../enums/ErrorCodeConstants.java

java

ErrorCode {ENTITY}_NOT_EXISTS = new ErrorCode(1_0XX_0YY_000, "当前{实体中文名}不存在");

The error code number should be sequential after the existing number range, and the message should be in Chinese.

Step 2: Create DO

File:

dal/dataobject/{entity}/{Entity}DO.java

Inherit

BaseDO

, use annotations such as

@TableName

@TableId

, and

@Builder

. Write Javadoc for each field.

Step 3: Create Mapper

File:

dal/mysql/{entity}/{Entity}Mapper.java

Inherit

BaseMapperX<{Entity}DO>

, implement pagination using

default

methods and

LambdaQueryWrapperX

Step 4: Create VO

Directory:

controller/admin/{entity}/vo/

File	Purpose
`{Entity}PageReqVO`	Pagination request, inherits `PageParam`
`{Entity}SaveReqVO`	Shared for create/update operations
`{Entity}RespVO`	Response (includes export annotations)

Add

@Schema

to all fields, and

@NotNull

@NotBlank

for required fields.

Step 5: Create Service Interface

File:

service/{entity}/{Entity}Service.java

Write Javadoc for every method. Return DO (Controller layer converts to VO).

Standard methods:

create{Entity}

update{Entity}

delete{Entity}

get{Entity}

get{Entity}Page

Step 6: Implement Service

File:

service/{entity}/{Entity}ServiceImpl.java

Inject Mapper using
```
@Resource
```
Perform business validation (existence, uniqueness) before writing
Validation methods start with
```
validate
```
Throw exceptions using
```
throw exception(ErrorCode)
```
Convert VO to DO using
```
BeanUtils.toBean()
```

Step 7: Create Controller

Refer to the Controller template of the

proxy-backend-api-design

skill.

@Tag

@Operation

@Parameter

@PreAuthorize

@Valid

CommonResult<T>

Step 8: Write SQL

Table creation SQL (refer to the
```
proxy-backend-database
```
skill template)
Menu SQL (directory menu + button permissions)
Dictionary SQL (if enum fields need to be displayed as dictionaries)

Step 9: Self-Check Checklist

ErrorCodeConstants are defined
DO inherits BaseDO, fields have comments
Mapper inherits BaseMapperX, pagination is implemented
VOs are correctly categorized, fields have
```
@Schema
```
Service interface methods have Javadoc
ServiceImpl has complete validation
Controller has complete documentation annotations and correct permission codes
Table creation SQL includes required fields and comments
Menu SQL permission codes match those in Controller
No TODO/FIXME, no hardcoding, batch operations replace loops

Step 10: Output Frontend Integration Checklist

After completion, output the interface list, permission codes, dictionary types, and generated file list for frontend use.

For detailed template, see references/frontend-checklist.md.

proxy-backend-impl-workflow

NPX Install

Tags

SKILL.md Content (Chinese)

Java CRUD Interface Implementation Workflow

Preparations

Implementation Steps

Step 1: Define Error Codes

Step 2: Create DO

Step 3: Create Mapper

Step 4: Create VO

Step 5: Create Service Interface

Step 6: Implement Service

Step 7: Create Controller

Step 8: Write SQL

Step 9: Self-Check Checklist

Step 10: Output Frontend Integration Checklist