jhipster-entities

JHipster Entities -- Microservices

Create and manage JHipster entities in a microservices architecture where entities belong to specific services and cross-service relationships use IDs instead of foreign keys.

When to Use

• When creating entities assigned to specific microservices
• When defining cross-service relationships (by ID, not FK)
• When generating code with jhipster import-jdl for microservices
• When implementing Feign-based data fetching across services

Available Operations

1. Define entities with microservice assignment in JDL
2. Handle cross-service references with ID fields
3. Generate code per microservice
4. Implement Feign-based data aggregation
5. Create shared DTOs for inter-service communication

Multi-Step Workflow

Step 1: Define Entities with Microservice Assignment

/* demand-service entities */
entity Demand {
    description TextBlob required
    status DemandStatus required
    priority Priority required
    createdAt Instant required
}

entity Task {
    description String required maxlength(500)
    status TaskStatus required
    agentId Long             // ID from another service, not FK
    branchName String
}

relationship OneToMany {
    Demand{tasks} to Task{demand required}
}

microservice Demand, Task with demandService

/* agent-service entities */
entity Agent {
    name String required
    type AgentType required
    status AgentStatus required
    worktreePath String
}

entity AgentTeam {
    demandId Long required   // ID from another service, not FK
}

relationship ManyToMany {
    AgentTeam{agents} to Agent
}

microservice Agent, AgentTeam with agentService

Step 2: Generate Code

# Generate all microservices from JDL
jhipster import-jdl jhipster-jdl.jdl

# Verify generated files per service
ls demand-service/src/main/java/*/domain/
ls agent-service/src/main/java/*/domain/

Step 3: Implement Cross-Service Data Fetching

// In demand-service -- Task stores only agentId
@Entity
public class Task {
    private Long agentId;  // Just the ID, not the Agent entity
}

// In demand-service -- fetch Agent data via Feign
@Service
public class DemandServiceImpl {
    private final AgentServiceClient agentClient;

    public TaskDetailDTO getTaskDetail(Long taskId) {
        Task task = taskRepository.findById(taskId).orElseThrow();
        AgentDTO agent = agentClient.getAgent(task.getAgentId()); // Feign call
        return new TaskDetailDTO(task, agent);
    }
}