chore: Add workflow and activity annoations

Signed-off-by: Javier Aliaga <javier@diagrid.io>

Author: javier-aliaga

dapr-spring/dapr-spring-workflows/src/main/java/io/dapr/spring/workflows/config/DaprWorkflowsConfiguration.java

@@ -15,6 +15,8 @@
 
 import io.dapr.workflows.Workflow;
 import io.dapr.workflows.WorkflowActivity;
+import io.dapr.workflows.annotations.ActivityDefinition;
+import io.dapr.workflows.annotations.WorkflowDefinition;
 import io.dapr.workflows.runtime.WorkflowRuntime;
 import io.dapr.workflows.runtime.WorkflowRuntimeBuilder;
 import org.slf4j.Logger;
@@ -46,17 +48,38 @@ private void registerWorkflowsAndActivities(ApplicationContext applicationContex
     Map<String, Workflow> workflowBeans = applicationContext.getBeansOfType(Workflow.class);
 
     for (Workflow workflow :  workflowBeans.values()) {
-      LOGGER.info("Dapr Workflow: '{}' registered", workflow.getClass().getName());
 
-      workflowRuntimeBuilder.registerWorkflow(workflow);
+      // Get the workflowDefinition annotation from the workflow class and validate it
+      // If the annotation is not present, register the instance
+      // If preset register with the workflowDefinition annotation values
+      WorkflowDefinition workflowDefinition = workflow.getClass().getAnnotation(WorkflowDefinition.class);
+
+      if (workflowDefinition == null) {
+        // No annotation present, register the instance with default behavior
+        LOGGER.info("Dapr Workflow: '{}' registered", workflow.getClass().getName());
+        workflowRuntimeBuilder.registerWorkflow(workflow);
+        continue;
+      }
+
+      // Register with annotation values
+      String workflowName = workflowDefinition.name();
+      String workflowVersion = workflowDefinition.version();
+      boolean isLatest = workflowDefinition.isLatest();
+
+      workflowRuntimeBuilder.registerWorkflow(workflowName, workflow, workflowVersion, isLatest);
     }
 
     Map<String, WorkflowActivity> workflowActivitiesBeans = applicationContext.getBeansOfType(WorkflowActivity.class);
 
     for (WorkflowActivity activity :  workflowActivitiesBeans.values()) {
       LOGGER.info("Dapr Workflow Activity: '{}' registered", activity.getClass().getName());
+      ActivityDefinition activityDefinition = activity.getClass().getAnnotation(ActivityDefinition.class);
+      if (activityDefinition == null) {
+        workflowRuntimeBuilder.registerActivity(activity);
+        continue;
+      }
 
-      workflowRuntimeBuilder.registerActivity(activity);
+      workflowRuntimeBuilder.registerActivity(activityDefinition.name(), activity);
     }
 
     WorkflowRuntime runtime = workflowRuntimeBuilder.build();

sdk-workflows/src/main/java/io/dapr/workflows/Workflow.java

@@ -36,16 +36,4 @@ default void run(WorkflowContext ctx) {
 
     stub.run(ctx);
   }
-
-  default String getName() {
-    return null;
-  }
-
-  default String getVersion() {
-    return null;
-  }
-
-  default Boolean isLatestVersion() {
-    return false;
-  }
 }

sdk-workflows/src/main/java/io/dapr/workflows/WorkflowActivity.java

@@ -42,8 +42,4 @@ public interface WorkflowActivity {
    * @return any serializable value to be returned to the calling orchestrator.
    */
   Object run(WorkflowActivityContext ctx);
-
-  default String getName() {
-    return null;
-  }
 }

sdk-workflows/src/main/java/io/dapr/workflows/annotations/ActivityDefinition.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2026 The Dapr Authors
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package io.dapr.workflows.annotations;
+
+public @interface ActivityDefinition {
+  /**
+   * Name of the activity.
+   *
+   * @return the name of the activity.
+   */
+  String name() default "";
+}

sdk-workflows/src/main/java/io/dapr/workflows/annotations/WorkflowDefinition.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2026 The Dapr Authors
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package io.dapr.workflows.annotations;
+
+public @interface WorkflowDefinition {
+  /**
+   * Name of the workflow.
+   * Required when version is specified.
+   *
+   * @return the name of the workflow.
+   */
+  String name() default "";
+
+
+  /**
+   * Version of the workflow.
+   * When specified, name must also be provided.
+   *
+   * @return the version of the workflow.
+   */
+
+  String version() default "";
+
+  /**
+   * Specifies if the version is the latest or not.
+   * When true, the version and name must be provided.
+   *
+   * @return true if the version is the latest
+   */
+  boolean isLatest() default false;
+}

sdk-workflows/src/main/java/io/dapr/workflows/runtime/WorkflowRuntimeBuilder.java

@@ -145,6 +145,11 @@ public <T extends Workflow> WorkflowRuntimeBuilder registerWorkflow(String name,
                                                                       Class<T> clazz,
                                                                       String versionName,
                                                                       Boolean isLatestVersion) {
+
+    if (StringUtils.isEmpty(name)) {
+      throw new IllegalArgumentException("Workflow name cannot be empty");
+    }
+
     this.builder.addOrchestration(new WorkflowClassWrapper<>(name, clazz, versionName, isLatestVersion));
     this.workflowSet.add(name);
     this.workflows.add(name);
@@ -168,19 +173,7 @@ public <T extends Workflow> WorkflowRuntimeBuilder registerWorkflow(String name,
    */
   public <T extends Workflow> WorkflowRuntimeBuilder registerWorkflow(T instance) {
     var name = instance.getClass().getCanonicalName();
-
-    if (StringUtils.isEmpty(instance.getName())) {
-      this.registerWorkflow(name, instance, null, null);
-      return this;
-    }
-
-    if (StringUtils.isEmpty(instance.getVersion())) {
-      this.registerWorkflow(instance.getName(), instance, null, null);
-      return this;
-    }
-
-
-    this.registerWorkflow(instance.getName(), instance, instance.getVersion(), instance.isLatestVersion());
+    this.registerWorkflow(name, instance, null, null);
     return this;
   }
 
@@ -198,6 +191,10 @@ public <T extends Workflow> WorkflowRuntimeBuilder registerWorkflow(String name,
                                                                       T instance,
                                                                       String versionName,
                                                                       Boolean isLatestVersion) {
+    if (StringUtils.isEmpty(name)) {
+      throw new IllegalArgumentException("Workflow name cannot be empty");
+    }
+
     this.builder.addOrchestration(new WorkflowInstanceWrapper<>(name, instance, versionName, isLatestVersion));
     this.workflowSet.add(name);
     this.workflows.add(name);
@@ -232,6 +229,10 @@ public <T extends WorkflowActivity> WorkflowRuntimeBuilder registerActivity(Clas
    * @return the WorkflowRuntimeBuilder
    */
   public <T extends WorkflowActivity> WorkflowRuntimeBuilder registerActivity(String name, Class<T> clazz) {
+    if (StringUtils.isEmpty(name)) {
+      throw new IllegalArgumentException("Activity name cannot be empty");
+    }
+
     this.builder.addActivity(new WorkflowActivityClassWrapper<>(name, clazz));
     this.activitySet.add(name);
     this.activities.add(name);
@@ -249,9 +250,6 @@ public <T extends WorkflowActivity> WorkflowRuntimeBuilder registerActivity(Stri
    * @return the WorkflowRuntimeBuilder
    */
   public <T extends WorkflowActivity> WorkflowRuntimeBuilder registerActivity(T instance) {
-    if (StringUtils.isNotBlank(instance.getName())) {
-      return this.registerActivity(instance.getName(), instance);
-    }
     return this.registerActivity(instance.getClass().getCanonicalName(), instance);
   }
 
@@ -320,5 +318,4 @@ public WorkflowRuntimeBuilder registerTaskOrchestrationFactory(
 
     return this;
   }
-
-}
+}

sdk-workflows/src/test/java/io/dapr/workflows/runtime/WorkflowRuntimeBuilderTest.java

@@ -45,11 +45,15 @@ public WorkflowStub create() {
   @Test
   public void registerValidWorkflowInstances() {
     var b = new WorkflowRuntimeBuilder();
-    assertDoesNotThrow(() -> b.registerWorkflow(new TestWorkflowWithName()));
-    assertDoesNotThrow(() -> b.registerWorkflow(new TestWorkflowWithNameAndVersion()));
-    assertDoesNotThrow(() -> b.registerWorkflow(new TestWorkflowWithNameAndVersionIsLatest()));
-    Assert.assertThrows(IllegalArgumentException.class, () -> b.registerWorkflow(new TestWorkflowWithNameAndVersion()));
-    Assert.assertThrows(IllegalArgumentException.class, () -> b.registerWorkflow(new TestWorkflowWithNameAndVersionIsLatest()));
+
+    assertDoesNotThrow(() -> b.registerWorkflow("TestWorkflow", new TestWorkflow(), null, null));
+    assertDoesNotThrow(() -> b.registerWorkflow("NameWithClass", TestWorkflow.class));
+//    assertDoesNotThrow(() -> b.registerWorkflow(new TestWorkflowWithNameAndVersionIsLatest()));
+
+    Assert.assertThrows(IllegalArgumentException.class, () -> b.registerWorkflow("", new TestWorkflow(), null, null));
+    Assert.assertThrows(IllegalArgumentException.class, () -> b.registerWorkflow("", TestWorkflow.class, null, null));
+    Assert.assertThrows(IllegalArgumentException.class, () -> b.registerActivity("", new TestActivity()));
+    Assert.assertThrows(IllegalArgumentException.class, () -> b.registerActivity("", TestActivity.class));
   }
 
   public static class TestActivity implements WorkflowActivity {
@@ -191,58 +195,4 @@ public void buildTest() {
       }
     });
   }
-
-  public static class TestWorkflowWithName implements Workflow {
-    @Override
-    public WorkflowStub create() {
-      return ctx -> {
-      };
-    }
-
-    @Override
-    public String getName() {
-      return "TestWorkflowWithName";
-    }
-  }
-
-  public static class TestWorkflowWithNameAndVersion implements Workflow {
-    @Override
-    public WorkflowStub create() {
-      return ctx -> {
-      };
-    }
-
-    @Override
-    public String getName() {
-      return "TestWorkflowWithNameAndVersion";
-    }
-
-    @Override
-    public String getVersion() {
-      return "TestWorkflowWithNameAndVersion";
-    }
-  }
-
-  public static class TestWorkflowWithNameAndVersionIsLatest implements Workflow {
-    @Override
-    public WorkflowStub create() {
-      return ctx -> {
-      };
-    }
-
-    @Override
-    public String getName() {
-      return "TestWorkflowWithNameAndVersion";
-    }
-
-    @Override
-    public String getVersion() {
-      return "1";
-    }
-
-    @Override
-    public Boolean isLatestVersion() {
-      return true;
-    }
-  }
 }

spring-boot-examples/workflows/versioning/full-version-worker-one/src/main/java/io/dapr/springboot/examples/workerone/RegisterV1Components.java

@@ -19,6 +19,8 @@
 import io.dapr.workflows.WorkflowActivityContext;
 import io.dapr.workflows.WorkflowContext;
 import io.dapr.workflows.WorkflowStub;
+import io.dapr.workflows.annotations.ActivityDefinition;
+import io.dapr.workflows.annotations.WorkflowDefinition;
 import org.checkerframework.checker.units.qual.C;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -29,6 +31,7 @@
 public class RegisterV1Components  {
 
   @Component
+  @WorkflowDefinition(name = "FullVersionWorkflow", version = "V1", isLatest = true)
   public static class FullVersionWorkflow implements Workflow {
 
     @Override
@@ -42,24 +45,10 @@ public WorkflowStub create() {
         ctx.complete(result);
       };
     }
-
-    @Override
-    public String getName() {
-      return "FullVersionWorkflow";
-    }
-
-    @Override
-    public String getVersion() {
-      return "V1";
-    }
-
-    @Override
-    public Boolean isLatestVersion() {
-      return true;
-    }
   }
 
   @Component
+  @ActivityDefinition(name = Activity1.name)
   public static class Activity1 implements WorkflowActivity {
     private final Logger logger = LoggerFactory.getLogger(Activity1.class);
     public static final String name = "Activity1";
@@ -68,14 +57,10 @@ public Object run(WorkflowActivityContext ctx) {
       logger.info(name + " started");
       return name;
     }
-
-    @Override
-    public String getName() {
-      return name;
-    }
   }
 
   @Component
+  @ActivityDefinition(name = Activity2.name)
   public static class Activity2 implements WorkflowActivity {
     private final Logger logger = LoggerFactory.getLogger(Activity2.class);
     public static final String name = "Activity2";
@@ -84,11 +69,5 @@ public Object run(WorkflowActivityContext ctx) {
       logger.info(name + " started");
       return name;
     }
-
-    @Override
-    public String getName() {
-      return name;
-    }
   }
-
 }