440 lines
19 KiB
HTML
440 lines
19 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="generator" content="Asciidoctor 1.5.8">
|
||
<title>AWS Lambda</title>
|
||
<link rel="stylesheet" href="css/spring.css">
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
|
||
|
||
<style>
|
||
.hidden {
|
||
display: none;
|
||
}
|
||
|
||
.switch {
|
||
border-width: 1px 1px 0 1px;
|
||
border-style: solid;
|
||
border-color: #7a2518;
|
||
display: inline-block;
|
||
}
|
||
|
||
.switch--item {
|
||
padding: 10px;
|
||
background-color: #ffffff;
|
||
color: #7a2518;
|
||
display: inline-block;
|
||
cursor: pointer;
|
||
}
|
||
|
||
.switch--item:not(:first-child) {
|
||
border-width: 0 0 0 1px;
|
||
border-style: solid;
|
||
border-color: #7a2518;
|
||
}
|
||
|
||
.switch--item.selected {
|
||
background-color: #7a2519;
|
||
color: #ffffff;
|
||
}
|
||
</style>
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/zepto/1.2.0/zepto.min.js"></script>
|
||
<script type="text/javascript">
|
||
function addBlockSwitches() {
|
||
$('.primary').each(function() {
|
||
primary = $(this);
|
||
createSwitchItem(primary, createBlockSwitch(primary)).item.addClass("selected");
|
||
primary.children('.title').remove();
|
||
});
|
||
$('.secondary').each(function(idx, node) {
|
||
secondary = $(node);
|
||
primary = findPrimary(secondary);
|
||
switchItem = createSwitchItem(secondary, primary.children('.switch'));
|
||
switchItem.content.addClass('hidden');
|
||
findPrimary(secondary).append(switchItem.content);
|
||
secondary.remove();
|
||
});
|
||
}
|
||
|
||
function createBlockSwitch(primary) {
|
||
blockSwitch = $('<div class="switch"></div>');
|
||
primary.prepend(blockSwitch);
|
||
return blockSwitch;
|
||
}
|
||
|
||
function findPrimary(secondary) {
|
||
candidate = secondary.prev();
|
||
while (!candidate.is('.primary')) {
|
||
candidate = candidate.prev();
|
||
}
|
||
return candidate;
|
||
}
|
||
|
||
function createSwitchItem(block, blockSwitch) {
|
||
blockName = block.children('.title').text();
|
||
content = block.children('.content').first().append(block.next('.colist'));
|
||
item = $('<div class="switch--item">' + blockName + '</div>');
|
||
item.on('click', '', content, function(e) {
|
||
$(this).addClass('selected');
|
||
$(this).siblings().removeClass('selected');
|
||
e.data.siblings('.content').addClass('hidden');
|
||
e.data.removeClass('hidden');
|
||
});
|
||
blockSwitch.append(item);
|
||
return {'item': item, 'content': content};
|
||
}
|
||
|
||
$(addBlockSwitches);
|
||
</script>
|
||
|
||
</head>
|
||
<body class="book toc2 toc-left">
|
||
<div id="header">
|
||
<div id="toc" class="toc2">
|
||
<div id="toctitle">Table of Contents</div>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_aws_lambda">AWS Lambda</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div id="content">
|
||
<div id="preamble">
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>This project provides an adapter layer for a Spring Cloud Function application onto AWS Lambda. You can write an app with a single <code>@Bean</code> of type <code>Function</code>, <code>Consumer</code> or <code>Supplier</code> and it will be deployable in AWS if you get the JAR file laid out right. The best way to make it work is to include <code>spring-cloud-function-context</code> as a dependency, but not the higher level adapters (e.g. <code>spring-cloud-function-stream</code>).</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_aws_lambda"><a class="link" href="#_aws_lambda">AWS Lambda</a></h3>
|
||
<div class="paragraph">
|
||
<p>The <a href="https://aws.amazon.com/">AWS</a> adapter takes a Spring Cloud Function app and converts it to a form that can run in AWS Lambda.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>The details of how to get stared with AWS Lambda is out of scope of this document, so the expectation is that user has some familiarity with
|
||
AWS and AWS Lambda and wants to learn what additional value spring provides.</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getting_started"><a class="link" href="#_getting_started">Getting Started</a></h4>
|
||
<div class="paragraph">
|
||
<p>One of the goals of Spring Cloud Function framework is to provide necessary infrastructure elements to enable a <em>simple function application</em>
|
||
to interact in a certain way in a particular environment.
|
||
A simple function application (in context or Spring) is an application that contains beans of type Supplier, Function or Consumer.
|
||
So, with AWS it means that a simple function bean should somehow be recognised and executed in AWS Lambda environment.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Let’s look at the example:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">@SpringBootApplication
|
||
public class FunctionConfiguration {
|
||
|
||
public static void main(String[] args) {
|
||
SpringApplication.run(FunctionConfiguration.class, args);
|
||
}
|
||
|
||
@Bean
|
||
public Function<String, String> uppercase() {
|
||
return value -> value.toUpperCase();
|
||
}
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>It shows a complete Spring Boot application with a function bean defined in it. What’s interesting is that on the surface this is just
|
||
another boot app, but in the context of AWS Adapter it is also a perfectly valid AWS Lambda application. No other code or configuration
|
||
is required. All you need to do is package it and deploy it, so let’s look how we can do that.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>To make things simpler we’ve provided a sample project ready to be built and deployed and you can access it
|
||
<a href="https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-samples/function-sample-aws">here</a>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>You simply execute <code>./mvnw clean package</code> to generate JAR file. All the necessary maven plugins have already been setup to generate
|
||
appropriate AWS deployable JAR file. (You can read more details about JAR layout in <a href="#_notes_on_jar_layout">Notes on JAR Layout</a>).</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Then you have to upload the JAR file (via AWS dashboard or AWS CLI) to AWS.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>When ask about <em>handler</em> you specify <code>org.springframework.cloud.function.adapter.aws.FunctionInvoker::handleRequest</code> which is a generic request handler.</p>
|
||
</div>
|
||
<div class="imageblock text-center">
|
||
<div class="content">
|
||
<img src="https://raw.githubusercontent.com/spring-cloud/spring-cloud-function/master/docs/src/main/asciidoc/images/AWS-deploy.png" alt="AWS deploy" width="800">
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>That is all. Save and execute the function with some sample data which for this function is expected to be a
|
||
String which function will uppercase and return back.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>While <code>org.springframework.cloud.function.adapter.aws.FunctionInvoker</code> is a general purpose AWS’s <code>RequestHandler</code> implementation aimed at completely
|
||
isolating you from the specifics of AWS Lambda API, for some cases you may want to specify which specific AWS’s <code>RequestHandler</code> you want
|
||
to use. The next section will explain you how you can accomplish just that.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_aws_request_handlers"><a class="link" href="#_aws_request_handlers">AWS Request Handlers</a></h4>
|
||
<div class="paragraph">
|
||
<p>The adapter has a couple of generic request handlers that you can use. The most generic is (and the one we used in the Getting Started section)
|
||
is <code>org.springframework.cloud.function.adapter.aws.FunctionInvoke</code> which is the implementation of AWS’s <code>RequestStreamHandler</code>.
|
||
User doesn’t need to do anything other then specify it as 'handler' on AWS dashborad when deploying function.
|
||
It will handle most of the case including Kinesis, streaming etc. .</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>The most generic is
|
||
<code>SpringBootStreamHandler</code>, which uses a Jackson <code>ObjectMapper</code> provided by Spring Boot to serialize and deserialize the objects
|
||
in the function. There is also a <code>SpringBootRequestHandler</code> which you can extend, and provide the input and output types as type
|
||
parameters (enabling AWS to inspect the class and do the JSON conversions itself).</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>If your app has more than one <code>@Bean</code> of type <code>Function</code> etc. then you can choose the one to use by configuring <code>function.name</code>
|
||
(e.g. as <code>FUNCTION_NAME</code> environment variable in AWS). The functions are extracted from the Spring Cloud <code>FunctionCatalog</code>
|
||
(searching first for <code>Function</code> then <code>Consumer</code> and finally <code>Supplier</code>).</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_notes_on_jar_layout"><a class="link" href="#_notes_on_jar_layout">Notes on JAR Layout</a></h4>
|
||
<div class="paragraph">
|
||
<p>You don’t need the Spring Cloud Function Web or Stream adapter at runtime in Lambda, so you might
|
||
need to exclude those before you create the JAR you send to AWS. A Lambda application has to be
|
||
shaded, but a Spring Boot standalone application does not, so you can run the same app using 2
|
||
separate jars (as per the sample). The sample app creates 2 jar files, one with an <code>aws</code>
|
||
classifier for deploying in Lambda, and one <a id="thin-jar"></a> executable (thin) jar that includes <code>spring-cloud-function-web</code>
|
||
at runtime. Spring Cloud Function will try and locate a "main class" for you from the JAR file
|
||
manifest, using the <code>Start-Class</code> attribute (which will be added for you by the Spring Boot
|
||
tooling if you use the starter parent). If there is no <code>Start-Class</code> in your manifest you can
|
||
use an environment variable or system property <code>MAIN_CLASS</code> when you deploy the function to AWS.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>If you are not using the functional bean definitions but relying on Spring Boot’s auto-configuration,
|
||
then additional transformers must be configured as part of the maven-shade-plugin execution.</p>
|
||
</div>
|
||
<div id="shade-plugin-setup" class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><plugin>
|
||
<groupId>org.apache.maven.plugins</groupId>
|
||
<artifactId>maven-shade-plugin</artifactId>
|
||
<dependencies>
|
||
<dependency>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-maven-plugin</artifactId>
|
||
</dependency>
|
||
</dependencies>
|
||
<configuration>
|
||
<createDependencyReducedPom>false</createDependencyReducedPom>
|
||
<shadedArtifactAttached>true</shadedArtifactAttached>
|
||
<shadedClassifierName>aws</shadedClassifierName>
|
||
<transformers>
|
||
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
|
||
<resource>META-INF/spring.handlers</resource>
|
||
</transformer>
|
||
<transformer implementation="org.springframework.boot.maven.PropertiesMergingResourceTransformer">
|
||
<resource>META-INF/spring.factories</resource>
|
||
</transformer>
|
||
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
|
||
<resource>META-INF/spring.schemas</resource>
|
||
</transformer>
|
||
</transformers>
|
||
</configuration>
|
||
</plugin></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_build_file_setup"><a class="link" href="#_build_file_setup">Build file setup</a></h4>
|
||
<div class="paragraph">
|
||
<p>In order to run Spring Cloud Function applications on AWS Lambda, you can leverage Maven or Gradle
|
||
plugins offered by the cloud platform provider.</p>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_maven"><a class="link" href="#_maven">Maven</a></h5>
|
||
<div class="paragraph">
|
||
<p>In order to use the adapter plugin for Maven, add the plugin dependency to your <code>pom.xml</code>
|
||
file:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><dependencies>
|
||
<dependency>
|
||
<groupId>org.springframework.cloud</groupId>
|
||
<artifactId>spring-cloud-function-adapter-aws</artifactId>
|
||
</dependency>
|
||
</dependencies></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>As pointed out in the <a href="#_notes_on_jar_layout">Notes on JAR Layout</a>, you wil need a shaded jar in order to upload it
|
||
to AWS Lambda. You can use the <a href="https://maven.apache.org/plugins/maven-shade-plugin/">Maven Shade Plugin</a> for that.
|
||
The example of the <a href="#shade-plugin-setup">setup</a> can be found above.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>You can use theSpring Boot Maven Plugin to generate the <a href="#thin-jar">thin jar</a>.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><plugin>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-maven-plugin</artifactId>
|
||
<dependencies>
|
||
<dependency>
|
||
<groupId>org.springframework.boot.experimental</groupId>
|
||
<artifactId>spring-boot-thin-layout</artifactId>
|
||
<version>${wrapper.version}</version>
|
||
</dependency>
|
||
</dependencies>
|
||
</plugin></code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>You can find the entire sample <code>pom.xml</code> file for deploying Spring Cloud Function
|
||
applications to AWS Lambda with Maven <a href="https://github.com/spring-cloud/spring-cloud-function/blob/master/spring-cloud-function-samples/function-sample-aws/pom.xml">here</a>.</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_gradle"><a class="link" href="#_gradle">Gradle</a></h5>
|
||
<div class="paragraph">
|
||
<p>In order to use the adapter plugin for Gradle, add the dependency to your <code>build.gradle</code> file:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">dependencies {
|
||
compile("org.springframework.cloud:spring-cloud-function-adapter-aws:${version}")
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>As pointed out in <a href="#_notes_on_jar_layout">Notes on JAR Layout</a>, you wil need a shaded jar in order to upload it
|
||
to AWS Lambda. You can use the <a href="https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow/">Gradle Shadow Plugin</a> for that:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">buildscript {
|
||
dependencies {
|
||
classpath "com.github.jengelman.gradle.plugins:shadow:${shadowPluginVersion}"
|
||
}
|
||
}
|
||
apply plugin: 'com.github.johnrengelman.shadow'
|
||
|
||
assemble.dependsOn = [shadowJar]
|
||
|
||
import com.github.jengelman.gradle.plugins.shadow.transformers.*
|
||
|
||
shadowJar {
|
||
classifier = 'aws'
|
||
dependencies {
|
||
exclude(
|
||
dependency("org.springframework.cloud:spring-cloud-function-web:${springCloudFunctionVersion}"))
|
||
}
|
||
// Required for Spring
|
||
mergeServiceFiles()
|
||
append 'META-INF/spring.handlers'
|
||
append 'META-INF/spring.schemas'
|
||
append 'META-INF/spring.tooling'
|
||
transform(PropertiesFileTransformer) {
|
||
paths = ['META-INF/spring.factories']
|
||
mergeStrategy = "append"
|
||
}
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>You can use the Spring Boot Gradle Plugin and Spring Boot Thin Gradle Plugin to generate
|
||
the <a href="#thin-jar">thin jar</a>.</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">buildscript {
|
||
dependencies {
|
||
classpath("org.springframework.boot.experimental:spring-boot-thin-gradle-plugin:${wrapperVersion}")
|
||
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
|
||
}
|
||
}
|
||
apply plugin: 'org.springframework.boot'
|
||
apply plugin: 'org.springframework.boot.experimental.thin-launcher'
|
||
assemble.dependsOn = [thinJar]</code></pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>You can find the entire sample <code>build.gradle</code> file for deploying Spring Cloud Function
|
||
applications to AWS Lambda with Gradle <a href="https://github.com/spring-cloud/spring-cloud-function/blob/master/spring-cloud-function-samples/function-sample-aws/build.gradle">here</a>.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_upload"><a class="link" href="#_upload">Upload</a></h4>
|
||
<div class="paragraph">
|
||
<p>Build the sample under <code>spring-cloud-function-samples/function-sample-aws</code> and upload the <code>-aws</code> jar file to Lambda. The handler can be <code>example.Handler</code> or <code>org.springframework.cloud.function.adapter.aws.SpringBootStreamHandler</code> (FQN of the class, <em>not</em> a method reference, although Lambda does accept method references).</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>./mvnw -U clean package</pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>Using the AWS command line tools it looks like this:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>aws lambda create-function --function-name Uppercase --role arn:aws:iam::[USERID]:role/service-role/[ROLE] --zip-file fileb://function-sample-aws/target/function-sample-aws-2.0.0.BUILD-SNAPSHOT-aws.jar --handler org.springframework.cloud.function.adapter.aws.SpringBootStreamHandler --description "Spring Cloud Function Adapter Example" --runtime java8 --region us-east-1 --timeout 30 --memory-size 1024 --publish</pre>
|
||
</div>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>The input type for the function in the AWS sample is a Foo with a single property called "value". So you would need this to test it:</p>
|
||
</div>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>{
|
||
"value": "test"
|
||
}</pre>
|
||
</div>
|
||
</div>
|
||
<div class="admonitionblock note">
|
||
<table>
|
||
<tr>
|
||
<td class="icon">
|
||
<i class="fa icon-note" title="Note"></i>
|
||
</td>
|
||
<td class="content">
|
||
The AWS sample app is written in the "functional" style (as an <code>ApplicationContextInitializer</code>). This is much faster on startup in Lambda than the traditional <code>@Bean</code> style, so if you don’t need <code>@Beans</code> (or <code>@EnableAutoConfiguration</code>) it’s a good choice. Warm starts are not affected.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_type_conversion"><a class="link" href="#_type_conversion">Type Conversion</a></h4>
|
||
<div class="paragraph">
|
||
<p>Spring Cloud Function will attempt to transparently handle type conversion between the raw
|
||
input stream and types declared by your function.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>For example, if your function signature is as such <code>Function<Foo, Bar></code> we will attempt to convert
|
||
incoming stream event to an instance of <code>Foo</code>.</p>
|
||
</div>
|
||
<div class="paragraph">
|
||
<p>In the event type is not known or can not be determined (e.g., <code>Function<?, ?></code>) we will attempt to
|
||
convert an incoming stream event to a generic <code>Map</code>.</p>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_raw_input"><a class="link" href="#_raw_input">Raw Input</a></h6>
|
||
<div class="paragraph">
|
||
<p>There are times when you may want to have access to a raw input. In this case all you need is to declare your
|
||
function signature to accept <code>InputStream</code>. For example, <code>Function<InputStream, ?></code>. In this case
|
||
we will not attempt any conversion and will pass the raw input directly to a function.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<script type="text/javascript" src="js/tocbot/tocbot.min.js"></script>
|
||
<script type="text/javascript" src="js/toc.js"></script>
|
||
<link rel="stylesheet" href="js/highlight/styles/atom-one-dark-reasonable.min.css">
|
||
<script src="js/highlight/highlight.min.js"></script>
|
||
<script>hljs.initHighlighting()</script>
|
||
</body>
|
||
</html> |