Terminology
- spring boot: An open-source micro framework used to build stand-alone, auto-configurable and production-ready Spring Applications.
- heroku: A cloud platform as a service supporting several programming languages.
- maven: A build automation tool used primarily for Java projects. Just like gradle & ant.
Creating a Spring Boot API locally
Step 1: Initialise Spring Boot API using Spring Initializr
Step 2: Extract the zipped directory & open it as a project in IntelliJ. Maven will configure itself accordingly.
Step 3: Create the following java files in the src directory:
RunnerApplication.java
package tech.jaykay12.sbheroku;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class RunnerApplication {
public static void main( String[] args ) {
SpringApplication.run(RunnerApplication.class,args);
}
}
APIController.java
package tech.jaykay12.sbheroku;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class APIController {
@RequestMapping("/")
public String index(){
return "Spring BOOT Running!\n";
}
}
Tweaks
- Delete the
scope of spring-boot-starter-tomcat from `pom.xml` - Set the custom port for spring boot embedded tomcat to run by editing
application.properties
Step 4: Run the Spring Boot API using IntelliJ options or either post the .war packaging to any tomcat container.
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.3.4.RELEASE)
2020-10-15 23:57:02.695 INFO 20682 --- [main] t.jaykay12.sbheroku.RunnerApplication : Starting RunnerApplication on jalaz-personal with PID 20682 (/home/jalaz/Documents/springboot-heroku/target/classes started by jalaz in /home/jalaz/Documents/springboot-heroku)
2020-10-15 23:57:02.699 INFO 20682 --- [main] t.jaykay12.sbheroku.RunnerApplication : No active profile set, falling back to default profiles: default
2020-10-15 23:57:04.416 INFO 20682 --- [main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8090 (http)
2020-10-15 23:57:04.437 INFO 20682 --- [main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2020-10-15 23:57:04.437 INFO 20682 --- [main] org.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/9.0.38]
2020-10-15 23:57:04.600 INFO 20682 --- [main] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2020-10-15 23:57:04.600 INFO 20682 --- [main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 1727 ms
2020-10-15 23:57:04.943 INFO 20682 --- [main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService 'applicationTaskExecutor'
2020-10-15 23:57:05.335 INFO 20682 --- [main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8090 (http) with context path ''
2020-10-15 23:57:05.353 INFO 20682 --- [main] t.jaykay12.sbheroku.RunnerApplication : Started RunnerApplication in 3.669 seconds (JVM running for 4.506)
Step 5: On hitting, localhost:8090, if you get Spring BOOT Running!. Kudos, You got your Spring Boot API running locally.
Using already created Spring Boot API
Step 1: Get local copy of the API using
wget https://github.com/jaykay12/tech/blob/master/assets/demos/springboot-heroku.zip
Step 2 to 5: Remains the same as above.
Deploying on Heroku
Step 1: Logging into Heroku using heroku cli
jalaz@jalaz-personal:/work-samples/springboot-heroku$ heroku login
heroku: Press any key to open up the browser to login or q to exit:
Opening browser to https://cli-auth.heroku.com/auth/cli/browser/xxxxxx-xxxx-xxxx
Logging in... done
Logged in as jalazkumar1208@gmail.com
Step 2: Create a heroku app inside the directory
jalaz@jalaz-personal:~/work-samples/springboot-heroku$ heroku create springboot-heroku-jalaz
Creating ⬢ springboot-heroku-jalaz... done
https://springboot-heroku-jalaz.herokuapp.com/ | https://git.heroku.com/springboot-heroku-jalaz.git
Step 3: Initialise as git repo for smooth deployment of the app
jalaz@jalaz-personal:~/work-samples/springboot-heroku$ git init
Initialized empty Git repository in /home/jalaz/work-samples/springboot-heroku/.git/
jalaz@jalaz-personal:~/work-samples/springboot-heroku$ vi .gitignore
.idea
.mvn
target
jalaz@jalaz-personal:~/work-samples/springboot-heroku$ git add .
jalaz@jalaz-personal:~/work-samples/springboot-heroku$ git commit -m "Setup repo"
jalaz@jalaz-personal:~/work-samples/springboot-heroku$ git remote add heroku https://git.heroku.com/springboot-heroku-jalaz.git
jalaz@jalaz-personal:~/work-samples/springboot-heroku$ git remote -v
heroku https://git.heroku.com/springboot-heroku-jalaz.git (fetch)
heroku https://git.heroku.com/springboot-heroku-jalaz.git (push)
Step 4: Here a Procfile is not needed, pom.xml is itself self-sufficient.
Procfile: A text file in the root directory of your application, to explicitly declare what command should be executed to start your app
Step 5: Push to deploy.
jalaz@jalaz-personal:~/work-samples/springboot-heroku$ git push heroku master
Enumerating objects: 24, done.
Counting objects: 100% (24/24), done.
Delta compression using up to 4 threads
Compressing objects: 100% (15/15), done.
Writing objects: 100% (24/24), 9.52 KiB | 749.00 KiB/s, done.
Total 24 (delta 0), reused 0 (delta 0)
remote: Compressing source files... done.
remote: Building source:
remote:
remote: -----> Java app detected
remote: -----> Installing JDK 1.8... done
remote: -----> Installing Maven 3.6.2... done
remote: -----> Executing Maven
remote: $ mvn -DskipTests clean dependency:list install
remote: [INFO] Scanning for projects...
remote: [INFO] Downloading from central: https://repo.maven.apache.org/maven2/org/springframework/boot/spring-boot-starter-parent/2.3.4.RELEASE/spring-boot-starter-parent-2.3.4.RELEASE.pom
remote: [INFO] Downloaded from central: https://repo.maven.apache.org/maven2/org/springframework/boot/spring-boot-starter-parent/2.3.4.RELEASE/spring-boot-starter-parent-2.3.4.RELEASE.pom (8.6 kB at 13 kB/s)
-------------------------------- CONTINUED -----------------------------------
remote: [INFO] Installing /tmp/build_f51a6ec8/pom.xml to /tmp/codon/tmp/cache/.m2/repository/tech/jaykay12/springboot-heroku/0.0.1-SNAPSHOT/springboot-heroku-0.0.1-SNAPSHOT.pom
remote: [INFO] ------------------------------------------------------------------------
remote: [INFO] BUILD SUCCESS
remote: [INFO] ------------------------------------------------------------------------
remote: [INFO] Total time: 18.243 s
remote: [INFO] Finished at: 2020-10-28T17:38:14Z
remote: [INFO] ------------------------------------------------------------------------
remote: -----> Discovering process types
remote: Procfile declares types -> (none)
remote:
remote: -----> Compressing...
remote: Done: 94M
remote: -----> Launching...
remote: Released v3
remote: https://springboot-heroku-jalaz.herokuapp.com/ deployed to Heroku
remote:
remote: Verifying deploy... done.
To https://git.heroku.com/springboot-heroku-jalaz.git
* [new branch] master -> master