├── .gitignore ├── .mvn └── wrapper │ ├── MavenWrapperDownloader.java │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── README.md ├── docs ├── HLDS.png ├── process-flow.wsd └── process_flow.png ├── mvnw ├── mvnw.cmd ├── pom.xml ├── sequience-daigram └── process-flow.wsd └── src ├── main ├── java │ └── org │ │ └── soyphea │ │ ├── SpringBootAsyncClientApplication.java │ │ ├── config │ │ ├── AsyncConfig.java │ │ ├── CustomClientHttpRequestInterceptor.java │ │ ├── MyRestTemplateConfig.java │ │ └── MyRestTemplateCustomizer.java │ │ ├── domain │ │ ├── BaseCallBackResponse.java │ │ ├── BaseResultCallBack.java │ │ ├── StackOverflowTag.java │ │ └── StackOverflowTagList.java │ │ ├── job │ │ ├── AsyncBaseService.java │ │ └── STUserTagFetchingAsync.java │ │ ├── repository │ │ └── BaseResultCallBackRepository.java │ │ ├── utils │ │ └── UrlBuilder.java │ │ └── worker │ │ ├── MemoryCallbackStorageWorker.java │ │ ├── MongoDBCallbackStorageWorker.java │ │ ├── RedisCallbackStorageWorker.java │ │ ├── Status.java │ │ └── TaskCallbackStorageWorker.java └── resources │ └── application.yml └── test └── java └── org └── soyphea └── SpringBootAsyncClientApplicationTests.java /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/** 5 | !**/src/test/** 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | 30 | ### VS Code ### 31 | .vscode/ 32 | -------------------------------------------------------------------------------- /.mvn/wrapper/MavenWrapperDownloader.java: -------------------------------------------------------------------------------- 1 | /* 2 | Licensed to the Apache Software Foundation (ASF) under one 3 | or more contributor license agreements. See the NOTICE file 4 | distributed with this work for additional information 5 | regarding copyright ownership. The ASF licenses this file 6 | to you under the Apache License, Version 2.0 (the 7 | "License"); you may not use this file except in compliance 8 | with the License. You may obtain a copy of the License at 9 | 10 | https://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, 13 | software distributed under the License is distributed on an 14 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | KIND, either express or implied. See the License for the 16 | specific language governing permissions and limitations 17 | under the License. 18 | */ 19 | 20 | import java.io.File; 21 | import java.io.FileInputStream; 22 | import java.io.FileOutputStream; 23 | import java.io.IOException; 24 | import java.net.URL; 25 | import java.nio.channels.Channels; 26 | import java.nio.channels.ReadableByteChannel; 27 | import java.util.Properties; 28 | 29 | public class MavenWrapperDownloader { 30 | 31 | /** 32 | * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided. 33 | */ 34 | private static final String DEFAULT_DOWNLOAD_URL = 35 | "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar"; 36 | 37 | /** 38 | * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to 39 | * use instead of the default one. 40 | */ 41 | private static final String MAVEN_WRAPPER_PROPERTIES_PATH = 42 | ".mvn/wrapper/maven-wrapper.properties"; 43 | 44 | /** 45 | * Path where the maven-wrapper.jar will be saved to. 46 | */ 47 | private static final String MAVEN_WRAPPER_JAR_PATH = 48 | ".mvn/wrapper/maven-wrapper.jar"; 49 | 50 | /** 51 | * Name of the property which should be used to override the default download url for the wrapper. 52 | */ 53 | private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl"; 54 | 55 | public static void main(String args[]) { 56 | System.out.println("- Downloader started"); 57 | File baseDirectory = new File(args[0]); 58 | System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath()); 59 | 60 | // If the maven-wrapper.properties exists, read it and check if it contains a custom 61 | // wrapperUrl parameter. 62 | File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH); 63 | String url = DEFAULT_DOWNLOAD_URL; 64 | if(mavenWrapperPropertyFile.exists()) { 65 | FileInputStream mavenWrapperPropertyFileInputStream = null; 66 | try { 67 | mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile); 68 | Properties mavenWrapperProperties = new Properties(); 69 | mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream); 70 | url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url); 71 | } catch (IOException e) { 72 | System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'"); 73 | } finally { 74 | try { 75 | if(mavenWrapperPropertyFileInputStream != null) { 76 | mavenWrapperPropertyFileInputStream.close(); 77 | } 78 | } catch (IOException e) { 79 | // Ignore ... 80 | } 81 | } 82 | } 83 | System.out.println("- Downloading from: : " + url); 84 | 85 | File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH); 86 | if(!outputFile.getParentFile().exists()) { 87 | if(!outputFile.getParentFile().mkdirs()) { 88 | System.out.println( 89 | "- ERROR creating output direcrory '" + outputFile.getParentFile().getAbsolutePath() + "'"); 90 | } 91 | } 92 | System.out.println("- Downloading to: " + outputFile.getAbsolutePath()); 93 | try { 94 | downloadFileFromURL(url, outputFile); 95 | System.out.println("Done"); 96 | System.exit(0); 97 | } catch (Throwable e) { 98 | System.out.println("- Error downloading"); 99 | e.printStackTrace(); 100 | System.exit(1); 101 | } 102 | } 103 | 104 | private static void downloadFileFromURL(String urlString, File destination) throws Exception { 105 | URL website = new URL(urlString); 106 | ReadableByteChannel rbc; 107 | rbc = Channels.newChannel(website.openStream()); 108 | FileOutputStream fos = new FileOutputStream(destination); 109 | fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE); 110 | fos.close(); 111 | rbc.close(); 112 | } 113 | 114 | } 115 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PheaSoy/spring-boot-async-callback/49bb0e18ba7f99f16401a3463ebd43a60b9471ea/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.0/apache-maven-3.6.0-bin.zip 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Callback and Async Sample Solution Design Version 1.0 2 | ## Overview 3 | 4 | Build the API for scale and reliable might need a lot of things required such as Deployment Process 5 | that be able to scale, failover, Non-Blocking I/O framework, Messaging, Event-driven architecture etc. 6 | 7 | Sometime you need to increase amount of CPU/RAM to enable scale or deploy copy of replicas if you are using containerization. 8 | However if you build your API using Blocking IO, when the clients request thousand per second your API will be got pressure 9 | and your system failure was increasing. 10 | 11 | If your service call to downstream services by http protocol you're blocking process, network latency is increasing. 12 | * How we improve this process more reliable, async way and adopt with event-driven messaging? 13 | Let's take a look a sample design below. 14 | 15 | ![high-level-design](docs/HLDS.png) 16 | 17 | ## Quick Introduce Design 18 | Example you have an API call **Payment API** that provide the customer to do the payment. 19 | 20 | Basically instead provides the clients waits until a whole process completed and response back. 21 | We just need to init callback id and return a callback id that tell to the clients, please callback to get your result. 22 | 23 | What are the benefits for doing this? 24 | 25 | * **Make the system more reliable and robust** 26 | * **We can execute the process asynchronously and finally you just need to update the state**. 27 | 28 | example: 29 | ```java 30 | public CompletableFuture fetchTagsFromStackOverFlow(String userId) throws Exception { 31 | 32 | log.info("Fetching StackOverflow tags using RestTemplate+CompletableFuture with user id:{}", userId); 33 | CompletableFuture stackOverflowTagResponse = 34 | CompletableFuture.supplyAsync(() -> restTemplate.getForObject(urlBuilder.fullApiEndpoint(userId), 35 | StackOverflowTagList.class)); 36 | log.info("StackOverflow tags of user id:{} is done:{}", 37 | userId, stackOverflowTagResponse.isDone()); 38 | return stackOverflowTagResponse; 39 | 40 | } 41 | 42 | public CompletableFuture processBusinessLogic(String callbackId) throws Exception{ 43 | 44 | CompletableFuture result = fetchTagsFromStackOverFlow(callbackId) 45 | .thenApplyAsync(stackOverflowTagList -> { 46 | return applyMyBusinessLogic(stackOverflowTagList); 47 | }); 48 | return result; 49 | } 50 | public void execute(String userId, String callBackId) throws Exception { 51 | 52 | taskCallbackStorageWorker.processing(callBackId); 53 | processBusinessLogic(userId) 54 | .thenAcceptAsync(stackOverflowTagList -> 55 | taskCallbackStorageWorker.completed(callBackId, stackOverflowTagList) 56 | ); 57 | } 58 | 59 | ``` 60 | *By doing this all the process are asynchronous.* 61 | 62 | * **We can adopt with event-driven more easily and scale**. 63 | 64 | If we have a lot of downstream services, we just 65 | need to send all the events we need to them to perform through broker like RabbitMQ, ApacheKafka. 66 | 67 | When the downstream services completed, they just need send back the result. 68 | Then we just need to update the state. 69 | 70 | Example: you have two downstream services independent call, you can send the event asynchronously. 71 | 72 | * **Easy to trace the event, state and result** 73 | 74 | We can find any state and the result include the details like the root cause and the client can get the result whenever they want. 75 | 76 | They just need the callback id. It might be useful for reporting and reconciliation or settle. 77 | 78 | 79 | All the result with state are storing in memory by default for my design. 80 | 81 | We can just store it whatever that we want. It might be good for **Redis** memory data store or NoSQL for index searching with well document store as my sample design. 82 | 83 | ## Process Flow Detail 84 | ![process-flow](docs/process_flow.png) 85 | 86 | 87 | ## Spring Boot + Java Implementing 88 | 89 | * This is interface which provides the callback logic. 90 | ```java 91 | 92 | public interface TaskCallbackStorageWorker { 93 | void initStorage(BaseResultCallBack baseResultCallBack); 94 | void processing(String callBackId); 95 | void completed(String callBackId, T returnResult); 96 | void updateStatus(String callBackId, String status, T baseResultCallBack); 97 | Optional findResultFromStorage(String callBackId); 98 | 99 | default BaseCallBackResponse generateCallBackIdWithInitStatus() { 100 | 101 | String callBackId = UUID.randomUUID().toString(); 102 | BaseCallBackResponse apiResponse = new BaseCallBackResponse(callBackId); 103 | initStorage(new BaseResultCallBack( 104 | callBackId, Status.INIT.toString(), null 105 | )); 106 | return apiResponse; 107 | } 108 | } 109 | 110 | ``` 111 | 112 | Basically you can implement this class and provides your storage. I am just create a class `MemoryCallbackStorageWorker` which implemented this interface. 113 | So it's using hashmap with memory storage. 114 | 115 | ## Async Processing 116 | * This is my service abstract that annotation with `@Async`. In Spring Boot if you want the method running asynchronously you need to put `@Async` on your method level. 117 | 118 | If you want to learn more how to run method asynchronously in spring boot [check out here](https://spring.io/guides/gs/async-method/). 119 | 120 | 121 | ```java 122 | import org.soyphea.worker.TaskCallbackStorageWorker; 123 | import org.springframework.scheduling.annotation.Async; 124 | 125 | public abstract class AsyncBaseService { 126 | 127 | protected TaskCallbackStorageWorker taskCallbackStorageWorker; 128 | 129 | @Async 130 | abstract public void execute(String userId, String callBackId) throws Exception; 131 | 132 | public AsyncBaseService(TaskCallbackStorageWorker taskCallbackStorageWorker) { 133 | this.taskCallbackStorageWorker = taskCallbackStorageWorker; 134 | } 135 | } 136 | ``` 137 | 138 | 139 | * For my example, I am going to get all the user tags from stackoverflow by given user id. 140 | 141 | ```java 142 | @Slf4j 143 | @Service 144 | public class STUserTagFetchingAsync extends AsyncBaseService { 145 | 146 | @Autowired 147 | private UrlBuilder urlBuilder; 148 | 149 | @Qualifier("bootifulRestTemplate") 150 | 151 | @Autowired 152 | private RestTemplate restTemplate; 153 | 154 | public STUserTagFetchingAsync(TaskCallbackStorageWorker taskCallbackStorageWorker) { 155 | super(taskCallbackStorageWorker); 156 | } 157 | 158 | public CompletableFuture fetchTagsFromStackOverFlow(String userId) throws Exception { 159 | 160 | log.info("Fetching StackOverflow tags using RestTemplate+CompletableFuture with user id:{}", userId); 161 | CompletableFuture stackOverflowTagResponse = 162 | CompletableFuture.supplyAsync(() -> restTemplate.getForObject(urlBuilder.fullApiEndpoint(userId), 163 | StackOverflowTagList.class)); 164 | log.info("StackOverflow tags of user id:{} is done:{}", 165 | userId, stackOverflowTagResponse.isDone()); 166 | return stackOverflowTagResponse; 167 | 168 | } 169 | 170 | public CompletableFuture processBusinessLogic(String callbackId) throws Exception{ 171 | 172 | CompletableFuture result = fetchTagsFromStackOverFlow(callbackId) 173 | .thenApplyAsync(stackOverflowTagList -> { 174 | return applyMyBusinessLogic(stackOverflowTagList); 175 | }); 176 | return result; 177 | } 178 | 179 | @Async 180 | public StackOverflowTagList applyMyBusinessLogic(StackOverflowTagList stackOverflowTagList) { 181 | log.info("Apply my business logic from result might take some time."); 182 | return stackOverflowTagList; 183 | } 184 | 185 | public void execute(String userId, String callBackId) throws Exception { 186 | 187 | (1) taskCallbackStorageWorker.processing(callBackId); 188 | processBusinessLogic(userId) 189 | .thenAcceptAsync(stackOverflowTagList -> 190 | (2) taskCallbackStorageWorker.completed(callBackId, stackOverflowTagList) 191 | ); 192 | } 193 | } 194 | 195 | ``` 196 | 197 | **(1)** Init a callback 198 | 199 | **(2)** Update state with status COMPLETED. 200 | 201 | * This is my controller which get the request and return callback. 202 | 203 | ```java 204 | @Autowired 205 | private AsyncBaseService asyncBaseService; 206 | 207 | @Autowired 208 | private MemoryCallbackStorageWorker memoryCallbackStorageWorker; 209 | 210 | @GetMapping("/api/stackoverflow/{user_id}/tags") 211 | BaseCallBackResponse create(@PathVariable("user_id") String userId) throws Exception { 212 | (1) BaseCallBackResponse apiResponse = memoryCallbackStorageWorker.generateCallBackIdWithInitStatus(); 213 | log.info("API Response with callback id:{}", apiResponse.getCallBackId()); 214 | (2) asyncBaseService.execute(userId, apiResponse.getCallBackId()); 215 | return apiResponse; 216 | } 217 | 218 | ``` 219 | 220 | **(1)** Just init a callback that return callback_id and store it storage defined. 221 | 222 | **(2)** Execute a process include update status PROCESSING, COMPLETED. You should be able to define more, if you want. 223 | This is just my an example. 224 | 225 | You can combine all the async pipeline or send event in this process, finally just need to update the state. 226 | 227 | * This is controller that get the result from callback by given callback_id. 228 | 229 | ```java 230 | @GetMapping("/api/stackoverflow/{callback_id}/callbacks") 231 | BaseResultCallBack get(@PathVariable("callback_id") String callBackId) { 232 | return memoryCallbackStorageWorker.findResultFromStorage(callBackId).get(); 233 | } 234 | ``` 235 | 236 | ## What Next 237 | * Implement DECLINED status with limit of time 238 | * Implement number limit of processing callback 239 | * Implement MongoDB and Redis storage 240 | * Create Event-driven 241 | -------------------------------------------------------------------------------- /docs/HLDS.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PheaSoy/spring-boot-async-callback/49bb0e18ba7f99f16401a3463ebd43a60b9471ea/docs/HLDS.png -------------------------------------------------------------------------------- /docs/process-flow.wsd: -------------------------------------------------------------------------------- 1 | @startuml 2 | title : Create User Profile 3 | actor "User" as user 4 | participant "Service" as service 5 | database "Storage" as storage 6 | participant "Messaging" as messaging 7 | participant "DownStream Service" as downstream 8 | 9 | user -> service: API Called 10 | service -> service: Init callback 11 | service -> storage: Callback state INIT 12 | user <-- service: Return callback Id 13 | service -> storage: Callback state PROCESSING 14 | service -> service: Async JOB 15 | service -> messaging: Send envent notification 16 | messaging -> downstream: Send envent notification 17 | 18 | note right of service 19 | Async with CompletablFuture 20 | or Event-drivent send to downstream service 21 | end note 22 | 23 | user -> service: Get the result with Callback ID 24 | service -> storage: Get the result with Callback ID 25 | service <-- storage: Return Result 26 | user <-- service: State is PROCESSING 27 | messaging <-- downstream: Send envent feedback 28 | service <-- downstream: Send envent feedback 29 | service--> service: Update state COMPLTED + Result 30 | service -> storage: Callback state COMPLTED 31 | 32 | user -> service: Get the result with Callback ID 33 | service -> storage: Get the result with Callback ID 34 | service <-- storage: Return Result 35 | user <-- service: State is COMPLTED+Result 36 | @enduml 37 | -------------------------------------------------------------------------------- /docs/process_flow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PheaSoy/spring-boot-async-callback/49bb0e18ba7f99f16401a3463ebd43a60b9471ea/docs/process_flow.png -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 59 | if [ -z "$JAVA_HOME" ]; then 60 | if [ -x "/usr/libexec/java_home" ]; then 61 | export JAVA_HOME="`/usr/libexec/java_home`" 62 | else 63 | export JAVA_HOME="/Library/Java/Home" 64 | fi 65 | fi 66 | ;; 67 | esac 68 | 69 | if [ -z "$JAVA_HOME" ] ; then 70 | if [ -r /etc/gentoo-release ] ; then 71 | JAVA_HOME=`java-config --jre-home` 72 | fi 73 | fi 74 | 75 | if [ -z "$M2_HOME" ] ; then 76 | ## resolve links - $0 may be a link to maven's home 77 | PRG="$0" 78 | 79 | # need this for relative symlinks 80 | while [ -h "$PRG" ] ; do 81 | ls=`ls -ld "$PRG"` 82 | link=`expr "$ls" : '.*-> \(.*\)$'` 83 | if expr "$link" : '/.*' > /dev/null; then 84 | PRG="$link" 85 | else 86 | PRG="`dirname "$PRG"`/$link" 87 | fi 88 | done 89 | 90 | saveddir=`pwd` 91 | 92 | M2_HOME=`dirname "$PRG"`/.. 93 | 94 | # make it fully qualified 95 | M2_HOME=`cd "$M2_HOME" && pwd` 96 | 97 | cd "$saveddir" 98 | # echo Using m2 at $M2_HOME 99 | fi 100 | 101 | # For Cygwin, ensure paths are in UNIX format before anything is touched 102 | if $cygwin ; then 103 | [ -n "$M2_HOME" ] && 104 | M2_HOME=`cygpath --unix "$M2_HOME"` 105 | [ -n "$JAVA_HOME" ] && 106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 107 | [ -n "$CLASSPATH" ] && 108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 109 | fi 110 | 111 | # For Mingw, ensure paths are in UNIX format before anything is touched 112 | if $mingw ; then 113 | [ -n "$M2_HOME" ] && 114 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 115 | [ -n "$JAVA_HOME" ] && 116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 117 | # TODO classpath? 118 | fi 119 | 120 | if [ -z "$JAVA_HOME" ]; then 121 | javaExecutable="`which javac`" 122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 123 | # readlink(1) is not available as standard on Solaris 10. 124 | readLink=`which readlink` 125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 126 | if $darwin ; then 127 | javaHome="`dirname \"$javaExecutable\"`" 128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 129 | else 130 | javaExecutable="`readlink -f \"$javaExecutable\"`" 131 | fi 132 | javaHome="`dirname \"$javaExecutable\"`" 133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 134 | JAVA_HOME="$javaHome" 135 | export JAVA_HOME 136 | fi 137 | fi 138 | fi 139 | 140 | if [ -z "$JAVACMD" ] ; then 141 | if [ -n "$JAVA_HOME" ] ; then 142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 143 | # IBM's JDK on AIX uses strange locations for the executables 144 | JAVACMD="$JAVA_HOME/jre/sh/java" 145 | else 146 | JAVACMD="$JAVA_HOME/bin/java" 147 | fi 148 | else 149 | JAVACMD="`which java`" 150 | fi 151 | fi 152 | 153 | if [ ! -x "$JAVACMD" ] ; then 154 | echo "Error: JAVA_HOME is not defined correctly." >&2 155 | echo " We cannot execute $JAVACMD" >&2 156 | exit 1 157 | fi 158 | 159 | if [ -z "$JAVA_HOME" ] ; then 160 | echo "Warning: JAVA_HOME environment variable is not set." 161 | fi 162 | 163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 164 | 165 | # traverses directory structure from process work directory to filesystem root 166 | # first directory with .mvn subdirectory is considered project base directory 167 | find_maven_basedir() { 168 | 169 | if [ -z "$1" ] 170 | then 171 | echo "Path not specified to find_maven_basedir" 172 | return 1 173 | fi 174 | 175 | basedir="$1" 176 | wdir="$1" 177 | while [ "$wdir" != '/' ] ; do 178 | if [ -d "$wdir"/.mvn ] ; then 179 | basedir=$wdir 180 | break 181 | fi 182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 183 | if [ -d "${wdir}" ]; then 184 | wdir=`cd "$wdir/.."; pwd` 185 | fi 186 | # end of workaround 187 | done 188 | echo "${basedir}" 189 | } 190 | 191 | # concatenates all lines of a file 192 | concat_lines() { 193 | if [ -f "$1" ]; then 194 | echo "$(tr -s '\n' ' ' < "$1")" 195 | fi 196 | } 197 | 198 | BASE_DIR=`find_maven_basedir "$(pwd)"` 199 | if [ -z "$BASE_DIR" ]; then 200 | exit 1; 201 | fi 202 | 203 | ########################################################################################## 204 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 205 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 206 | ########################################################################################## 207 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 208 | if [ "$MVNW_VERBOSE" = true ]; then 209 | echo "Found .mvn/wrapper/maven-wrapper.jar" 210 | fi 211 | else 212 | if [ "$MVNW_VERBOSE" = true ]; then 213 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 214 | fi 215 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 216 | while IFS="=" read key value; do 217 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 218 | esac 219 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 220 | if [ "$MVNW_VERBOSE" = true ]; then 221 | echo "Downloading from: $jarUrl" 222 | fi 223 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 224 | 225 | if command -v wget > /dev/null; then 226 | if [ "$MVNW_VERBOSE" = true ]; then 227 | echo "Found wget ... using wget" 228 | fi 229 | wget "$jarUrl" -O "$wrapperJarPath" 230 | elif command -v curl > /dev/null; then 231 | if [ "$MVNW_VERBOSE" = true ]; then 232 | echo "Found curl ... using curl" 233 | fi 234 | curl -o "$wrapperJarPath" "$jarUrl" 235 | else 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Falling back to using Java to download" 238 | fi 239 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 240 | if [ -e "$javaClass" ]; then 241 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 242 | if [ "$MVNW_VERBOSE" = true ]; then 243 | echo " - Compiling MavenWrapperDownloader.java ..." 244 | fi 245 | # Compiling the Java class 246 | ("$JAVA_HOME/bin/javac" "$javaClass") 247 | fi 248 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 249 | # Running the downloader 250 | if [ "$MVNW_VERBOSE" = true ]; then 251 | echo " - Running MavenWrapperDownloader.java ..." 252 | fi 253 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 254 | fi 255 | fi 256 | fi 257 | fi 258 | ########################################################################################## 259 | # End of extension 260 | ########################################################################################## 261 | 262 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 263 | if [ "$MVNW_VERBOSE" = true ]; then 264 | echo $MAVEN_PROJECTBASEDIR 265 | fi 266 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 267 | 268 | # For Cygwin, switch paths to Windows format before running java 269 | if $cygwin; then 270 | [ -n "$M2_HOME" ] && 271 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 272 | [ -n "$JAVA_HOME" ] && 273 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 274 | [ -n "$CLASSPATH" ] && 275 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 276 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 277 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 278 | fi 279 | 280 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 281 | 282 | exec "$JAVACMD" \ 283 | $MAVEN_OPTS \ 284 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 285 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 286 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 287 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 124 | FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO ( 125 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | echo Found %WRAPPER_JAR% 132 | ) else ( 133 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 134 | echo Downloading from: %DOWNLOAD_URL% 135 | powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')" 136 | echo Finished downloading %WRAPPER_JAR% 137 | ) 138 | @REM End of extension 139 | 140 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 141 | if ERRORLEVEL 1 goto error 142 | goto end 143 | 144 | :error 145 | set ERROR_CODE=1 146 | 147 | :end 148 | @endlocal & set ERROR_CODE=%ERROR_CODE% 149 | 150 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 151 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 152 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 153 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 154 | :skipRcPost 155 | 156 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 157 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 158 | 159 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 160 | 161 | exit /B %ERROR_CODE% 162 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 2.1.8.RELEASE 9 | 10 | 11 | org.soyphea 12 | demo 13 | 0.0.1-SNAPSHOT 14 | Spring Boot Async Client 15 | Spring Boot Async Client with CompleteableFuture and Webclient 16 | 17 | 18 | 1.8 19 | 20 | 21 | 22 | 23 | org.springframework.boot 24 | spring-boot-starter-web 25 | 26 | 27 | 28 | org.projectlombok 29 | lombok 30 | true 31 | 32 | 33 | 34 | org.springframework.boot 35 | spring-boot-starter-test 36 | test 37 | 38 | 39 | 40 | org.apache.httpcomponents 41 | httpclient 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | org.springframework.boot 51 | spring-boot-maven-plugin 52 | 53 | 54 | 55 | 56 | 57 | -------------------------------------------------------------------------------- /sequience-daigram/process-flow.wsd: -------------------------------------------------------------------------------- 1 | @startuml 2 | title : Sample Callback Design 3 | actor "User" as user 4 | participant "Service" as service 5 | database "Storage" as storage 6 | participant "Messaging" as messaging 7 | participant "DownStream Service" as downstream 8 | 9 | user -> service: API Call 10 | service -> service: Init callback 11 | service -> storage: Callback state INIT 12 | user <-- service: Return callback Id 13 | service -> storage: Callback state PROCESSING 14 | service -> service: Async JOB 15 | service -> messaging: Send envent notification 16 | messaging -> downstream: Send envent notification 17 | 18 | note right of service 19 | Async processing 20 | or Event-drivent send to downstream service 21 | end note 22 | 23 | user -> service: Get the result with Callback ID 24 | service -> storage: Get the result with Callback ID 25 | service <-- storage: Return Result 26 | user <-- service: State is PROCESSING 27 | messaging <-- downstream: Send envent feedback 28 | service <-- downstream: Send envent feedback 29 | service--> service: Update state COMPLTED + Result 30 | service -> storage: Callback state COMPLTED 31 | 32 | user -> service: Get the result with Callback ID 33 | service -> storage: Get the result with Callback ID 34 | service <-- storage: Return Result 35 | user <-- service: State is COMPLTED+Result 36 | @enduml 37 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/SpringBootAsyncClientApplication.java: -------------------------------------------------------------------------------- 1 | package org.soyphea; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import org.soyphea.domain.BaseCallBackResponse; 5 | import org.soyphea.domain.BaseResultCallBack; 6 | import org.soyphea.job.AsyncBaseService; 7 | import org.soyphea.worker.MemoryCallbackStorageWorker; 8 | import org.springframework.beans.factory.annotation.Autowired; 9 | import org.springframework.boot.SpringApplication; 10 | import org.springframework.boot.autoconfigure.SpringBootApplication; 11 | import org.springframework.context.annotation.Bean; 12 | import org.springframework.scheduling.annotation.EnableAsync; 13 | import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; 14 | import org.springframework.web.bind.annotation.GetMapping; 15 | import org.springframework.web.bind.annotation.PathVariable; 16 | import org.springframework.web.bind.annotation.RestController; 17 | 18 | import java.util.concurrent.Executor; 19 | 20 | @SpringBootApplication 21 | @EnableAsync 22 | @RestController 23 | @Slf4j 24 | public class SpringBootAsyncClientApplication{ 25 | 26 | @Autowired 27 | private AsyncBaseService asyncBaseService; 28 | 29 | @Autowired 30 | private MemoryCallbackStorageWorker memoryCallbackStorageWorker; 31 | 32 | public static void main(String[] args) { 33 | 34 | SpringApplication.run(SpringBootAsyncClientApplication.class, args); 35 | } 36 | 37 | @GetMapping("/api/stackoverflow/{user_id}/tags") 38 | BaseCallBackResponse create(@PathVariable("user_id") String userId) throws Exception { 39 | BaseCallBackResponse apiResponse = memoryCallbackStorageWorker.generateCallBackIdWithInitStatus(); 40 | log.info("API Response with callback id:{}", apiResponse.getCallBackId()); 41 | asyncBaseService.execute(userId, apiResponse.getCallBackId()); 42 | return apiResponse; 43 | } 44 | 45 | @GetMapping("/api/stackoverflow/{callback_id}/callbacks") 46 | BaseResultCallBack get(@PathVariable("callback_id") String callBackId) { 47 | return memoryCallbackStorageWorker.findResultFromStorage(callBackId).get(); 48 | } 49 | 50 | 51 | } 52 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/config/AsyncConfig.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.config; 2 | 3 | import org.springframework.context.annotation.Bean; 4 | import org.springframework.context.annotation.Configuration; 5 | import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; 6 | 7 | import java.util.concurrent.Executor; 8 | 9 | @Configuration 10 | public class AsyncConfig { 11 | @Bean 12 | public Executor taskExecutor() { 13 | ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); 14 | executor.setCorePoolSize(100); 15 | executor.setMaxPoolSize(100); 16 | executor.setQueueCapacity(500); 17 | executor.setThreadNamePrefix("ST-Overflow-"); 18 | executor.initialize(); 19 | return executor; 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/config/CustomClientHttpRequestInterceptor.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.config; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import org.springframework.http.HttpRequest; 5 | import org.springframework.http.client.ClientHttpRequestExecution; 6 | import org.springframework.http.client.ClientHttpRequestInterceptor; 7 | import org.springframework.http.client.ClientHttpResponse; 8 | import org.springframework.scheduling.annotation.Async; 9 | 10 | import java.io.IOException; 11 | 12 | @Slf4j 13 | public class CustomClientHttpRequestInterceptor implements ClientHttpRequestInterceptor { 14 | 15 | @Override 16 | public ClientHttpResponse intercept( 17 | HttpRequest request, byte[] body, 18 | ClientHttpRequestExecution execution) throws IOException { 19 | logRequestDetails(request); 20 | return execution.execute(request, body); 21 | } 22 | 23 | @Async 24 | private void logRequestDetails(HttpRequest request) { 25 | log.info("Made a http request with Headers: {} Msethod:{} URI:{}", request.getHeaders(),request.getMethod(),request.getURI()); 26 | } 27 | 28 | } 29 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/config/MyRestTemplateConfig.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.config; 2 | 3 | import org.springframework.boot.web.client.RestTemplateBuilder; 4 | import org.springframework.boot.web.client.RestTemplateCustomizer; 5 | import org.springframework.context.annotation.Bean; 6 | import org.springframework.context.annotation.Configuration; 7 | import org.springframework.context.annotation.Primary; 8 | import org.springframework.http.client.ClientHttpRequestFactory; 9 | import org.springframework.http.client.HttpComponentsClientHttpRequestFactory; 10 | import org.springframework.web.client.RestTemplate; 11 | 12 | @Configuration 13 | public class MyRestTemplateConfig { 14 | 15 | @Bean 16 | public RestTemplateCustomizer restTemplateCustomizer(){ 17 | return new MyRestTemplateCustomizer(); 18 | } 19 | 20 | @Bean("bootifulRestTemplate") 21 | @Primary 22 | RestTemplate restTemplate() { 23 | return new RestTemplateBuilder(restTemplateCustomizer()).build(); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/config/MyRestTemplateCustomizer.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.config; 2 | 3 | import org.springframework.boot.web.client.RestTemplateCustomizer; 4 | import org.springframework.context.annotation.Configuration; 5 | import org.springframework.http.client.HttpComponentsClientHttpRequestFactory; 6 | import org.springframework.web.client.RestTemplate; 7 | 8 | @Configuration 9 | public class MyRestTemplateCustomizer implements RestTemplateCustomizer { 10 | 11 | @Override 12 | public void customize(RestTemplate restTemplate) { 13 | HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(); 14 | requestFactory.setReadTimeout(30000); 15 | requestFactory.setConnectTimeout(30000); 16 | restTemplate.setRequestFactory(requestFactory); 17 | //restTemplate.getInterceptors().add(new CustomClientHttpRequestInterceptor()); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/domain/BaseCallBackResponse.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.domain; 2 | 3 | import com.fasterxml.jackson.annotation.JsonProperty; 4 | import lombok.*; 5 | 6 | @AllArgsConstructor 7 | @NoArgsConstructor 8 | @ToString 9 | @Getter 10 | @Setter 11 | public class BaseCallBackResponse { 12 | 13 | @JsonProperty("callback_id") 14 | private String callBackId; 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/domain/BaseResultCallBack.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.domain; 2 | 3 | import lombok.AllArgsConstructor; 4 | import lombok.Getter; 5 | import lombok.NoArgsConstructor; 6 | import lombok.Setter; 7 | 8 | @Setter 9 | @Getter 10 | @AllArgsConstructor 11 | @NoArgsConstructor 12 | public class BaseResultCallBack { 13 | 14 | String callBackId; 15 | String status; 16 | T result; 17 | 18 | 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/domain/StackOverflowTag.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.domain; 2 | 3 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties; 4 | import com.fasterxml.jackson.annotation.JsonProperty; 5 | import lombok.*; 6 | 7 | @Getter 8 | @Setter 9 | @NoArgsConstructor 10 | @AllArgsConstructor 11 | @JsonIgnoreProperties(ignoreUnknown=true) 12 | @ToString 13 | public class StackOverflowTag { 14 | 15 | @JsonProperty("user_id") 16 | String userId; 17 | String name; 18 | int count; 19 | 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/domain/StackOverflowTagList.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.domain; 2 | 3 | import com.fasterxml.jackson.annotation.JsonProperty; 4 | import lombok.Getter; 5 | import lombok.Setter; 6 | import lombok.ToString; 7 | 8 | import java.util.ArrayList; 9 | import java.util.List; 10 | 11 | @ToString 12 | @Getter 13 | @Setter 14 | public class StackOverflowTagList { 15 | 16 | @JsonProperty("items") 17 | List stackOverflowTags; 18 | 19 | public StackOverflowTagList() { 20 | stackOverflowTags = new ArrayList<>(); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/job/AsyncBaseService.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.job; 2 | 3 | import org.soyphea.worker.TaskCallbackStorageWorker; 4 | import org.springframework.scheduling.annotation.Async; 5 | 6 | public abstract class AsyncBaseService { 7 | 8 | protected TaskCallbackStorageWorker taskCallbackStorageWorker; 9 | 10 | @Async 11 | abstract public void execute(String userId, String callBackId) throws Exception; 12 | 13 | public AsyncBaseService(TaskCallbackStorageWorker taskCallbackStorageWorker) { 14 | this.taskCallbackStorageWorker = taskCallbackStorageWorker; 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/job/STUserTagFetchingAsync.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.job; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import org.soyphea.domain.StackOverflowTagList; 5 | import org.soyphea.worker.TaskCallbackStorageWorker; 6 | import org.soyphea.utils.UrlBuilder; 7 | import org.springframework.beans.factory.annotation.Autowired; 8 | import org.springframework.beans.factory.annotation.Qualifier; 9 | import org.springframework.scheduling.annotation.Async; 10 | import org.springframework.stereotype.Service; 11 | import org.springframework.web.client.RestTemplate; 12 | 13 | import java.util.concurrent.CompletableFuture; 14 | 15 | @Slf4j 16 | @Service 17 | public class STUserTagFetchingAsync extends AsyncBaseService { 18 | 19 | @Autowired 20 | private UrlBuilder urlBuilder; 21 | 22 | @Qualifier("bootifulRestTemplate") 23 | 24 | @Autowired 25 | private RestTemplate restTemplate; 26 | 27 | public STUserTagFetchingAsync(TaskCallbackStorageWorker taskCallbackStorageWorker) { 28 | super(taskCallbackStorageWorker); 29 | } 30 | 31 | public CompletableFuture fetchTagsFromStackOverFlow(String userId) throws Exception { 32 | 33 | log.info("Fetching StackOverflow tags using RestTemplate+CompletableFuture with user id:{}", userId); 34 | CompletableFuture stackOverflowTagResponse = 35 | CompletableFuture.supplyAsync(() -> restTemplate.getForObject(urlBuilder.fullApiEndpoint(userId), 36 | StackOverflowTagList.class)); 37 | log.info("StackOverflow tags of user id:{} is done:{}", 38 | userId, stackOverflowTagResponse.isDone()); 39 | return stackOverflowTagResponse; 40 | 41 | } 42 | 43 | public CompletableFuture processBusinessLogic(String callbackId) throws Exception{ 44 | 45 | CompletableFuture result = fetchTagsFromStackOverFlow(callbackId) 46 | .thenApplyAsync(stackOverflowTagList -> { 47 | return applyMyBusinessLogic(stackOverflowTagList); 48 | }); 49 | return result; 50 | } 51 | 52 | @Async 53 | public StackOverflowTagList applyMyBusinessLogic(StackOverflowTagList stackOverflowTagList) { 54 | log.info("Apply my business logic from result might take some time."); 55 | return stackOverflowTagList; 56 | } 57 | 58 | public void execute(String userId, String callBackId) throws Exception { 59 | 60 | taskCallbackStorageWorker.processing(callBackId); 61 | processBusinessLogic(userId) 62 | .thenAcceptAsync(stackOverflowTagList -> 63 | taskCallbackStorageWorker.completed(callBackId, stackOverflowTagList) 64 | ); 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/repository/BaseResultCallBackRepository.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.repository; 2 | 3 | public class BaseResultCallBackRepository { 4 | } 5 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/utils/UrlBuilder.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.utils; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import org.springframework.beans.factory.annotation.Value; 5 | import org.springframework.stereotype.Service; 6 | 7 | @Service 8 | public class UrlBuilder { 9 | 10 | @Value("${stackoverflow.api.base-url}") 11 | String stackOverflowBaseURL; 12 | 13 | @Value("${stackoverflow.api.tag}") 14 | String getStackOverflowApiTag; 15 | 16 | public String fullApiEndpoint(String userId) { 17 | 18 | StringBuilder api = new StringBuilder(stackOverflowBaseURL); 19 | api.append(getStackOverflowApiTag); 20 | String endpoint = api.toString().replace("{user_id}",userId); 21 | return endpoint; 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/worker/MemoryCallbackStorageWorker.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.worker; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import org.soyphea.domain.BaseCallBackResponse; 5 | import org.soyphea.domain.BaseResultCallBack; 6 | import org.springframework.stereotype.Service; 7 | 8 | import java.util.*; 9 | 10 | 11 | @Service 12 | @Slf4j 13 | public class MemoryCallbackStorageWorker implements TaskCallbackStorageWorker { 14 | 15 | private static HashMap myMemoryStorage = new HashMap<>(); 16 | 17 | 18 | public void initStorage(BaseResultCallBack baseResultCallBack) { 19 | myMemoryStorage.put(baseResultCallBack.getCallBackId(),baseResultCallBack); 20 | 21 | } 22 | 23 | public void processing(String callBackId) { 24 | updateStatus(callBackId, Status.PROCESSING.toString(), null); 25 | } 26 | 27 | public void completed(String callBackId, Object returnResult) { 28 | updateStatus(callBackId, Status.COMPLETED.toString(), returnResult); 29 | } 30 | 31 | public BaseCallBackResponse generateCallBackIdWithInitStatus() { 32 | String callBackId = UUID.randomUUID().toString(); 33 | log.info("Init callback with id:{}", callBackId); 34 | BaseCallBackResponse apiResponse = new BaseCallBackResponse(callBackId); 35 | initStorage(new BaseResultCallBack( 36 | callBackId, Status.INIT.toString(), null 37 | )); 38 | return apiResponse; 39 | } 40 | 41 | @Override 42 | public Optional findResultFromStorage(String callBackId) { 43 | return Optional.ofNullable(myMemoryStorage.get(callBackId)); 44 | } 45 | 46 | @Override 47 | public void updateStatus(String callBackId, String status, Object baseResultCallBack) { 48 | log.info("Update callback id:{} with status:{}", callBackId, status); 49 | Optional optionalStackOverflowTagListStorage = findResultFromStorage(callBackId); 50 | if (optionalStackOverflowTagListStorage.isPresent()) { 51 | BaseResultCallBack baseResultCallBackResult = new BaseResultCallBack(); 52 | baseResultCallBackResult.setStatus(status); 53 | baseResultCallBackResult.setResult(baseResultCallBack); 54 | baseResultCallBackResult.setCallBackId(callBackId); 55 | myMemoryStorage.put(callBackId,baseResultCallBackResult); 56 | } 57 | } 58 | 59 | 60 | } 61 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/worker/MongoDBCallbackStorageWorker.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.worker; 2 | 3 | import org.soyphea.domain.BaseResultCallBack; 4 | 5 | import java.util.Optional; 6 | 7 | public class MongoDBCallbackStorageWorker implements TaskCallbackStorageWorker { 8 | 9 | @Override 10 | public void initStorage(BaseResultCallBack baseResultCallBack) { 11 | 12 | } 13 | 14 | @Override 15 | public void processing(String callBackId) { 16 | 17 | } 18 | 19 | @Override 20 | public void completed(String callBackId, Object returnResult) { 21 | 22 | } 23 | 24 | @Override 25 | public void updateStatus(String callBackId, String status, Object baseResultCallBack) { 26 | 27 | } 28 | 29 | @Override 30 | public Optional findResultFromStorage(String callBackId) { 31 | return Optional.empty(); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/worker/RedisCallbackStorageWorker.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.worker; 2 | 3 | import org.soyphea.domain.BaseResultCallBack; 4 | 5 | import java.util.Optional; 6 | 7 | public class RedisCallbackStorageWorker implements TaskCallbackStorageWorker { 8 | 9 | @Override 10 | public void initStorage(BaseResultCallBack baseResultCallBack) { 11 | 12 | } 13 | 14 | @Override 15 | public void processing(String callBackId) { 16 | 17 | } 18 | 19 | @Override 20 | public void completed(String callBackId, Object returnResult) { 21 | 22 | } 23 | 24 | @Override 25 | public void updateStatus(String callBackId, String status, Object baseResultCallBack) { 26 | 27 | } 28 | 29 | @Override 30 | public Optional findResultFromStorage(String callBackId) { 31 | return Optional.empty(); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/worker/Status.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.worker; 2 | 3 | public enum Status { 4 | INIT,PROCESSING,COMPLETED 5 | } 6 | -------------------------------------------------------------------------------- /src/main/java/org/soyphea/worker/TaskCallbackStorageWorker.java: -------------------------------------------------------------------------------- 1 | package org.soyphea.worker; 2 | 3 | import org.soyphea.domain.BaseCallBackResponse; 4 | import org.soyphea.domain.BaseResultCallBack; 5 | 6 | import java.util.Optional; 7 | import java.util.UUID; 8 | 9 | 10 | public interface TaskCallbackStorageWorker { 11 | void initStorage(BaseResultCallBack baseResultCallBack); 12 | void processing(String callBackId); 13 | void completed(String callBackId, T returnResult); 14 | void updateStatus(String callBackId, String status, T baseResultCallBack); 15 | Optional findResultFromStorage(String callBackId); 16 | 17 | default BaseCallBackResponse generateCallBackIdWithInitStatus() { 18 | 19 | String callBackId = UUID.randomUUID().toString(); 20 | BaseCallBackResponse apiResponse = new BaseCallBackResponse(callBackId); 21 | initStorage(new BaseResultCallBack( 22 | callBackId, Status.INIT.toString(), null 23 | )); 24 | return apiResponse; 25 | 26 | } 27 | 28 | 29 | } 30 | -------------------------------------------------------------------------------- /src/main/resources/application.yml: -------------------------------------------------------------------------------- 1 | stackoverflow: 2 | api: 3 | base-url: https://api.stackexchange.com 4 | tag: /2.2/users/{user_id}/tags?order=desc&sort=popular&site=stackoverflow 5 | 6 | logging: 7 | level: 8 | org: 9 | soyphea: DEBUG 10 | 11 | management: 12 | endpoints: 13 | web: 14 | exposure: 15 | include: '*' 16 | spring: 17 | profiles: 18 | active: 'completablefuture' 19 | server: 20 | port: 9090 -------------------------------------------------------------------------------- /src/test/java/org/soyphea/SpringBootAsyncClientApplicationTests.java: -------------------------------------------------------------------------------- 1 | package org.soyphea; 2 | 3 | import org.junit.Test; 4 | import org.junit.runner.RunWith; 5 | import org.springframework.boot.test.context.SpringBootTest; 6 | import org.springframework.test.context.junit4.SpringRunner; 7 | 8 | @RunWith(SpringRunner.class) 9 | @SpringBootTest 10 | public class SpringBootAsyncClientApplicationTests { 11 | 12 | @Test 13 | public void contextLoads() { 14 | } 15 | 16 | } 17 | --------------------------------------------------------------------------------