You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repo contains library for building Azure Java Functions. Visit the [complete documentation of Azure Functions - Java Developer Guide](https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-java) for more details.
8
+
# Additional artifacts for Azure Java Functions
9
+
This repo contains two additional artifacts for building Azure Java Functions.
For more information about Azure Java Functions please visit the [complete documentation of Azure Functions - Java Developer Guide](https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-java) for more details.
10
14
11
15
## azure-functions-maven plugin
12
16
[How to use azure-functions-maven plugin to create, update, deploy and test azure java functions](https://docs.microsoft.com/en-us/java/api/overview/azure/maven/azure-functions-maven-plugin/readme?view=azure-java-stable)
@@ -21,207 +25,12 @@ Please see for details on Parent POM https://github.com/Microsoft/maven-java-par
21
25
22
26
## Summary
23
27
24
-
Azure Functions is a solution for easily running small pieces of code, or "functions," in the cloud. You can write just the code you need for the problem at hand, without worrying about a whole application or the infrastructure to run it. Functions can make development even more productive.Pay only for the time your code runs and trust Azure to scale as needed. Azure Functions lets you develop [serverless](https://azure.microsoft.com/en-us/solutions/serverless/) applications on Microsoft Azure.
25
-
26
-
Azure Functions supports triggers, which are ways to start execution of your code, and bindings, which are ways to simplify coding for input and output data. A function should be a stateless method to process input and produce output. Although you are allowed to write instance methods, your function must not depend on any instance fields of the class. You need to make sure all the function methods are `public` accessible and method with annotation @FunctionName is unique as that defines the entry for the the function.
27
-
28
-
A deployable unit is an uber JAR containing one or more functions (see below), and a JSON file with the list of functions and triggers definitions, deployed to Azure Functions. The JAR can be created in many ways, although we recommend [Azure Functions Maven Plugin](https://docs.microsoft.com/en-us/java/api/overview/azure/maven/azure-functions-maven-plugin/readme), as it provides templates to get you started with key scenarios.
29
-
30
-
All the input and output bindings can be defined in `function.json` (not recommended), or in the Java method by using annotations (recommended). All the types and annotations used in this document are included in the `azure-functions-java-library` package.
Azure Functions supports the use of 3rd party libraries. If using the Maven plugin for Azure Functions, all of your dependencies specified in your `pom.xml` file will be automatically bundled during the `mvn package` step.
53
-
54
-
## Data Types
55
-
56
-
You are free to use all the data types in Java for the input and output data, including native types; customized POJO types and specialized Azure types defined in this API. Azure Functions runtime will try its best to convert the actual input value to the type you need (for example, a `String` input will be treated as a JSON string and be parsed to a POJO type defined in your code).
57
-
58
-
### JSON Support
59
-
The POJO types (Java classes) you may define have to be publicly accessible (`public` modifier). POJO properties/fields may be `private`. For example a JSON string `{ "x": 3 }` is able to be converted to the following POJO type:
60
-
61
-
```java
62
-
publicclassPojoData {
63
-
privateint x;
64
-
}
65
-
```
66
-
67
-
### Other supported types
68
-
Binary data is represented as `byte[]` or `Byte[]` in your Azure functions code. And make sure you specify `dataType = "binary"` in the corresponding triggers/bindings.
69
-
70
-
Empty input values could be `null` as your functions argument, but a recommended way to deal with potential empty values is to use `Optional<T>` type.
71
-
72
-
73
-
## Inputs
74
-
75
-
Inputs are divided into two categories in Azure Functions: one is the trigger input and the other is the additional input. Trigger input is the input who triggers your function. And besides that, you may also want to get inputs from other sources (like a blob), that is the additional input.
76
-
77
-
Let's take the following code snippet as an example:
return"Hello, "+ in +" and "+ inputData.getRowKey() +".";
91
-
}
92
-
93
-
}
94
-
95
-
publicclassTestInputData {
96
-
publicStringgetRowKey() { returnthis.rowKey; }
97
-
privateString rowKey;
98
-
}
99
-
100
-
```
101
-
102
-
When this function is invoked, the HTTP request payload will be passed as the `String` for argument `in`; and one entry will be retrieved from the Azure Table Storage and be passed to argument `inputData` as `TestInputData` type.
103
-
104
-
To receive events in a batch when using EventHubTrigger, set cardinality to many and change input type to an array or List<>
context.getLogger().info("Java Event Hub trigger received messages. Batch size: "+ messages.size());
113
-
}
114
-
115
-
publicclassTestEventData {
116
-
publicString id;
117
-
}
118
-
119
-
```
120
-
121
-
Note: You can also bind to String[], TestEventData[] or List<String>
122
-
123
-
## Outputs
124
-
125
-
Outputs can be expressed in return value or output parameters. If there is only one output, you are recommended to use the return value. For multiple outputs, you have to use **output parameters**.
126
-
127
-
Return value is the simplest form of output, you just return the value of any type, and Azure Functions runtime will try to marshal it back to the actual type (such as an HTTP response). You could apply any *output annotations* to the function method (the `name` property of the annotation has to be `$return`) to define the return value output.
128
-
129
-
For example, a blob content copying function could be defined as the following code. `@StorageAccount` annotation is used here to prevent the duplicating of the `connection` property for both `@BlobTrigger` and `@BlobOutput`.
To produce multiple output values, use `OutputBinding<T>` type defined in the `azure-functions-java-library` package. If you need to make an HTTP response and push a message to a queue, you can write something like:
queue.setValue("This is the queue message to be pushed");
161
-
return"This is the HTTP response content";
162
-
}
163
-
}
164
-
```
165
-
166
-
Use `OutputBinding<byte[]>` type to make a binary output value (for parameters); for return values, just use `byte[]`.
167
-
168
-
## Execution Context
169
-
170
-
You interact with Azure Functions execution environment via the `ExecutionContext` object defined in the `azure-functions-java-library` package. You are able to get the invocation ID, the function name and a built-in logger (which is integrated prefectly with Azure Function Portal experience as well as AppInsights) from the context object.
171
-
172
-
What you need to do is just add one more `ExecutionContext` typed parameter to your function method. Let's take a timer triggered function as an example:
context.getLogger().info("Heartbeat triggered by "+ context.getFunctionName());
187
-
}
188
-
}
189
-
```
190
-
191
-
192
-
## Specialized Data Types
193
-
194
-
### HTTP Request and Response
195
-
196
-
Sometimes a function need to take a more detailed control of the input and output, and that's why we also provide some specialized types in the `azure-functions-java-library` package for you to manipulate:
|`HttpRequestMessage<T>`| HTTP Trigger | Get method, headers or queries |
201
-
|`HttpResponseMessage`| HTTP Output Binding | Return status other than 200 |
202
-
203
-
### Metadata
204
-
205
-
Metadata comes from different sources, like HTTP headers, HTTP queries, and [trigger metadata](https://docs.microsoft.com/en-us/azure/azure-functions/functions-triggers-bindings#trigger-metadata-properties). You can use `@BindingName` annotation together with the metadata name to get the value.
206
-
207
-
For example, the `queryValue` in the following code snippet will be `"test"` if the requested URL is `http://{example.host}/api/metadata?name=test`.
This repo contains core library for building Azure Java Functions. `azure-functions-java-core-library` contains base class for building Azure Java Functions.
5
+
However, you don't need to include `azure-functions-java-core-library` as a dependency when you build your function app, because it comes with [azure-functions-java-library](https://github.com/Azure/azure-functions-java-library)
6
+
which has a transitive dependency on `azure-functions-java-core-library`
7
+
8
+
For more information about Azure Java Functions please visit the [complete documentation of Azure Functions - Java Developer Guide](https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-java).
9
+
10
+
## azure-functions-maven plugin
11
+
[How to use azure-functions-maven plugin to create, update, deploy and test azure java functions](https://docs.microsoft.com/en-us/java/api/overview/azure/maven/azure-functions-maven-plugin/readme?view=azure-java-stable)
For samples of Azure function in Java please refer to [Azure Function Java Samples](https://github.com/Azure/azure-functions-java-library#sample)
24
+
and [Azure Functions Java Samples Repository](https://github.com/Azure-Samples/azure-functions-samples-java)
25
+
26
+
### License
27
+
28
+
This project is under the benevolent umbrella of the [.NET Foundation](http://www.dotnetfoundation.org/) and is licensed under [the MIT License](LICENSE.txt)
29
+
30
+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
0 commit comments