SpringCloud/spring-cloud-function
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Azure docs imporvements

Browse Source
This commit is contained in:
Christian Tzolov
2023-07-19 21:34:38 +02:00
parent 102d746dfd
commit bfde5c4c67
2 changed files with 48 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
docs/src/main/asciidoc/adapters/azure-intro.adoc
View File

@@ -33,7 +33,6 @@ files:
<dependency> <dependency>
<groupId>org.springframework.cloud</groupId> <groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-function-adapter-azure</artifactId> <artifactId>spring-cloud-function-adapter-azure</artifactId>
<version>4.0.3</version>
</dependency> </dependency>
</dependencies> </dependencies>
---- ----
@@ -42,7 +41,7 @@ files:
.Gradle .Gradle
---- ----
dependencies { dependencies {
implementation "org.springframework.cloud:spring-cloud-function-adapter-azure:4.0.3" implementation "org.springframework.cloud:spring-cloud-function-adapter-azure:<last version>"
} }
---- ----
==== ====
@@ -51,43 +50,35 @@ NOTE: version `4.0.0+` is required. Having the adapter on the classpath activate
=== Function Implementation === Function Implementation
All you need to annotate the your class with `@Component` or `@Service` annotations, auto-wire the required Spring beans (or the https://docs.spring.io/spring-cloud-function/docs/current/reference/html/spring-cloud-function.html#_function_catalog_and_flexible_function_signatures[FunctionCatalog] when using Spring Cloud Function), define and configure your Azure function handler. You can use the `@Component` (or `@Service`) annotation to turn any exiting Azure Function class (e.g. class with `@FunctionName` annotated handlers) into a Spring component.
Then you can auto-wire the required dependencies (or the https://docs.spring.io/spring-cloud-function/docs/current/reference/html/spring-cloud-function.html#_function_catalog_and_flexible_function_signatures[FunctionCatalog] instance for Spring Cloud Function) and use those inside your Azure function handler.
[source,java] [source,java]
---- ----
@SpringBootApplication @Component // <1>
public class MyAzureFunction { public class MyAzureFunction {
public static void main(String[] args) {
SpringApplication.run(MyAzureFunction.class, args);
}
// Plain Spring bean - not a Spring Cloud Functions! // Plain Spring bean - not a Spring Cloud Functions!
@Autowired @Autowired private Function<String, String> uppercase; // <2>
private Function<String, String> uppercase;
// The FunctionCatalog leverages the Spring Cloud Function framework. // The FunctionCatalog leverages the Spring Cloud Function framework.
@Autowired @Autowired private FunctionCatalog functionCatalog; // <2>
private FunctionCatalog functionCatalog;
@FunctionName("spring") @FunctionName("spring")
public String plainBean( // <1> public String plainBean( // <3>
@HttpTrigger(name = "req", methods = { HttpMethod.GET, @HttpTrigger(name = "req", authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
HttpMethod.POST }, authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
ExecutionContext context) { ExecutionContext context) {
return this.uppercase.apply(request.getBody().get()); return this.uppercase.apply(request.getBody().get());
} }
@FunctionName("scf") @FunctionName("scf")
public String springCloudFunction( // <2> public String springCloudFunction( // <4>
@HttpTrigger(name = "req", methods = { HttpMethod.GET, @HttpTrigger(name = "req", authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
HttpMethod.POST }, authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
ExecutionContext context) { ExecutionContext context) {
// Use SCF composition. Composed functions are not just spring beans but SCF such. // Use SCF composition. Composed functions are not just spring beans but SCF such.
Function composed = this.functionCatalog.lookup("reverse|uppercase"); Function composed = this.functionCatalog.lookup("reverse|uppercase"); // <5>
return (String) composed.apply(request.getBody().get()); return (String) composed.apply(request.getBody().get());
} }
@@ -98,25 +89,37 @@ When invoked by a trigger (such as `@HttpTrigger`), functions process that trigg
TIP: Use the Java annotations included in the https://learn.microsoft.com/en-us/java/api/com.microsoft.azure.functions.annotation?view=azure-java-stable[com.microsoft.azure.functions.annotation.*] package to bind input and outputs to your methods. TIP: Use the Java annotations included in the https://learn.microsoft.com/en-us/java/api/com.microsoft.azure.functions.annotation?view=azure-java-stable[com.microsoft.azure.functions.annotation.*] package to bind input and outputs to your methods.
<1> Indicates that the `MyAzureFunction` class is a "component" to be considered by the Spring Framework as a candidate for auto-detection and classpath scanning.
<2> Auto-wire the `uppercase` and `functionCatalog` beans defined in the `HttpTriggerDemoApplication` (below).
<3> The `plainBean` method handler is mapped to an Azure function that uses of the auto-wired `uppercase` spring bean to compute the result.
It demonstrates how to use "plain" Spring components in your Azure handlers.
<4> The `springCloudFunction` method handler is mapped to another Azure function, that uses the auto-wired `FunctionCatalog` instance to compute the result.
<5> Shows how to leverage the Spring Cloud Function https://docs.spring.io/spring-cloud-function/docs/current/reference/html/spring-cloud-function.html#_function_catalog_and_flexible_function_signatures[FunctionCatalog] composition API.
<1> The `plainBean` method handler is mapped to an Azure function, called `spring`, and when executed is uses of the auto-wired `uppercase` spring bean to compute the result. The actual Spring defined beans used inside the handlers looks like this:
This demonstrates how to use "plain" Spring components in your Azure handlers.
<2> The `springCloudFunction` method handler is mapped to the `scf` Azure function and shows how to use Spring Cloud Function composition in your handles.
The actual Spring defined functions you're delegating to looks like this:
[source,java] [source,java]
---- ----
@Bean @SpringBootApplication // <1>
public Function<String, String> uppercase() { public class HttpTriggerDemoApplication {
return payload -> payload.toUpperCase();
}
@Bean public static void main(String[] args) {
public Function<String, String> reverse() { SpringApplication.run(HttpTriggerDemoApplication.class, args);
return payload -> new StringBuilder(payload).reverse().toString(); }
@Bean
public Function<String, String> uppercase() { // <2>
return payload -> payload.toUpperCase();
}
@Bean
public Function<String, String> reverse() { // <2>
return payload -> new StringBuilder(payload).reverse().toString();
}
} }
---- ----
<1> the `@SpringBootApplication` annotated class should be used as Main-Class (or Start-Class) in you Maven/Gradle configurations as explained in <<star-class-configuration, star class configuration>>.
<2> Functions auto-wired and used in the Azure function handlers.
==== Accessing Azure ExecutionContext ==== Accessing Azure ExecutionContext
@@ -129,17 +132,18 @@ For that purpose the `AzureFunctionUtil.enhanceInputIfNecessary` allow you to ad
---- ----
@FunctionName("ditest") @FunctionName("ditest")
public String execute( public String execute(
@HttpTrigger(name = "req", methods = { HttpMethod.GET, @HttpTrigger(name = "req", authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
HttpMethod.POST }, authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request, ExecutionContext context) {
ExecutionContext context) {
Message message = (Message) AzureFunctionUtil.enhanceInputIfNecessary(request.getBody().get(), context); Message message =
(Message) AzureFunctionUtil.enhanceInputIfNecessary(request.getBody().get(), context); // <1>
return this.uppercase.apply(message); return this.uppercase.apply(message);
} }
---- ----
<1> Leverages the `AzureFunctionUtil` utility to inline the `context` as message header using the `AzureFunctionUtil.EXECUTION_CONTEXT` header key.
now you can retrieve it via the via `executionContext` key. Now you can retrieve the ExecutionContext from message headers:
[source,java] [source,java]
---- ----
@@ -147,11 +151,13 @@ now you can retrieve it via the via `executionContext` key.
public Function<Message<String>, String> uppercase(JsonMapper mapper) { public Function<Message<String>, String> uppercase(JsonMapper mapper) {
return message -> { return message -> {
String value = message.getPayload(); String value = message.getPayload();
ExecutionContext context = (ExecutionContext) message.getHeaders().get("executionContext"); ExecutionContext context =
(ExecutionContext) message.getHeaders().get(AzureFunctionUtil.EXECUTION_CONTEXT); // <1>
. . . . . .
} }
} }
---- ----
<1> Retrieve the ExecutionContext instance from the header.
=== Configuration and Project Layout === Configuration and Project Layout
@@ -246,6 +252,7 @@ azurefunctions {
The complete plugin documentation is available at the https://github.com/microsoft/azure-maven-plugins/tree/develop/azure-functions-maven-plugin[Azure Maven] and https://github.com/microsoft/azure-gradle-plugins/tree/master/azure-functions-gradle-plugin[Azure Gradle] repositories. The complete plugin documentation is available at the https://github.com/microsoft/azure-maven-plugins/tree/develop/azure-functions-maven-plugin[Azure Maven] and https://github.com/microsoft/azure-gradle-plugins/tree/master/azure-functions-gradle-plugin[Azure Gradle] repositories.
[[star-class-configuration]]
Next you must specify the `Start-Class` or `Main-Class` to point to your application main class. Next you must specify the `Start-Class` or `Main-Class` to point to your application main class.
==== ====
@@ -319,7 +326,6 @@ files:
<dependency> <dependency>
<groupId>org.springframework.cloud</groupId> <groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-function-adapter-azure-web</artifactId> <artifactId>spring-cloud-function-adapter-azure-web</artifactId>
<version>4.0.3</version>
</dependency> </dependency>
</dependencies> </dependencies>
---- ----
@@ -328,7 +334,7 @@ files:
.Gradle .Gradle
---- ----
dependencies { dependencies {
implementation "org.springframework.cloud:spring-cloud-function-adapter-azure-web:4.0.3" implementation "org.springframework.cloud:spring-cloud-function-adapter-azure-web:<last-version>"
} }
---- ----
==== ====

6
spring-cloud-function-samples/function-sample-azure-http-trigger/src/main/java/com/example/azure/di/httptriggerdemo/MyAzureFunction.java
View File

@@ -53,8 +53,7 @@ public class MyAzureFunction {
@FunctionName("bean") @FunctionName("bean")
public String plainBeans( public String plainBeans(
@HttpTrigger(name = "req", methods = { HttpMethod.GET, @HttpTrigger(name = "req", authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
HttpMethod.POST }, authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
ExecutionContext context) { ExecutionContext context) {
return echo.andThen(uppercase).apply(request.getBody().get()); return echo.andThen(uppercase).apply(request.getBody().get());
@@ -62,8 +61,7 @@ public class MyAzureFunction {
@FunctionName("scf") @FunctionName("scf")
public String springCloudFunction( public String springCloudFunction(
@HttpTrigger(name = "req", methods = { HttpMethod.GET, @HttpTrigger(name = "req", authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
HttpMethod.POST }, authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> request,
ExecutionContext context) { ExecutionContext context) {
// Use SCF composition. Composed functions are not just spring beans but SCF such. // Use SCF composition. Composed functions are not just spring beans but SCF such.