Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Writing better Spring applications using SpringFu

December 12, 2018
Faisal Masood
Related topics:
KubernetesJavaSpring Boot
Related products:
Red Hat OpenShift Container Platform

Share:

    "Truth can only be found in one place: the code," Robert C. Martin, Clean Code: A Handbook of Agile Software Craftsmanship.

    The way we structure our code has a direct impact on how understandable is it. Code that is easy to follow with no or less hidden functionality is much easier to maintain. It also makes it easier for our fellow programmers to track down bugs in the code. This helps us to avoid Venkat's Jesus Driven Development.

    The way I write Spring applications comprises heavy use of Spring annotations. The problem with this approach is that partial flow of the application is controlled by annotations. The complete flow of my code is not in one place, that is, in my code. I need to look back to the documentation to understand the annotations' behavior. By reading just the code, it is difficult to predict the flow of control.

    Luckily, Spring has a new way to code to and it has been called Spring Functional or SpringFu. In this article, I will use Kotlin to showcase some of the benefits you get from SpringFu.

    SpringFu to the rescue

    Let's start with a simple Spring-based application using the annotations approach. The first annotation we meet is @SpringBootApplication and it does many things. Surely this information is not captured in the code when you use this annotation, as you can see in the "Code with annotations" section below. When we proceed further in the code with annotations, @RestController does a series of things which further complicates the readability of code with respect to the control flow.

    @RequestMapping, @Autowired, and @Component all add up to the problem I mentioned above. Spring has to use reflection, Kotlin open classes, and all kind of facilities to make this code (magic) work. What if my goal is to read the code—and only the code—to understand the control flow.

    Reducing the usage of reflection will also help us in moving towards GraalVM based native code. First, take a look at the code with annotations below and see if you can get the flow of control. You can get a full example at my GitHub repository.

    Code with annotations

    @SpringBootApplication
    class SpringWithAnnotationsApplication
      fun main(args: Array<String>) {
        runApplication<SpringWithAnnotationsApplication>(*args)
      }
    
    @RestController
    @RequestMapping("/events")
    class EventHandler {
      @Autowired
      lateinit var eventService: EventService
    
      @GetMapping("/")
      fun getAllEvents () : List<Event> {
        return eventService.getAllEvents()
      }
    }
    
    @Component
    class EventService {
      fun getAllEvents() : List<Event>{
        return listOf(
                      Event(name = "event1", description = "desc1"),
                      Event(name = "event2", description = "desc2")
                     )
      }
    }
    
    data class Event (val name: String, val description: String)

    Visit Stack Overflow (some say Stack Overflow is the true technical lead) and you can find many questions about the right way to use annotations. The number and variety of questions will give you an idea of how important code readability is.

    "Programs must be written for people to read, and only incidentally for machines to execute," Abelson and Sussman.

    Code with no annotations

    Now let's try to write the same code using the SpringFu approach. The code is more readable and I can follow the full flow by just reading it. The flow of the code below is as follows.

    • I have a main function which loads my appSimple DSL.
    • The AppSimple DSL imports the Spring beans (which I have loaded in the eventBeans DSL) and configures what the server should do using the eventRoutes DSL.

    //create an application
    //remember no @SpringBootApplication
    fun main(args: Array<String>) {
      appSimple.run()
    }
    
    //using the application dsl, i define what my service will listen to
    val appSimple = application {
      //use the beans i define
      import(eventBeans)
      
      //http server listens for this endpoint
      server {
        import(::eventRoutes)
        codecs {
          jackson()
        }
      }
    }
    
    //define beans
    val eventBeans = beans {
      bean<EventService>()
      bean<EventHandler>()
    }
    
    //define on what endpont i would be listening
    //@RestController
    //@RequestMapping("/events")
    //@GetMapping("/")
    fun eventRoutes(handler: EventHandler) = router {
      "/events".nest {
        GET("/", handler::generateResponse)
      }
    }
    
    //create the handler for http request
    class EventHandler(private val eventService: EventService) {
      fun generateResponse(request: ServerRequest) = ServerResponse.ok().body(
        BodyInserters.fromObject(eventService.getAllEvents())
      )
    }
    
    //business logic
    // no need to @Component
    class EventService {
      fun getAllEvents(): List<Event> {
        return mutableListOf(
                             Event(name = "event1", description = "desc1"),
                             Event(name = "event2", description = "desc2")
        )
      }
    }
    
    data class Event(val name: String, val description: String)

    No need to open classes

    When using annotations, we need to make all classes open in order for Spring to work. See the pom.xml section below from the code. With SpringFu, final classes  are acceptable. Note the usage of the kotlin-maven-plugin below showcasing the use of automatically opening all the classes. This is some additional logic outside of my code and makes things difficult to read.

    <plugin>
      <artifactId>kotlin-maven-plugin</artifactId>
      <groupId>org.jetbrains.kotlin</groupId>
      <configuration>
        <args>
          <arg>-Xjsr305=strict</arg>
        </args>
        <compilerPlugins>
          <plugin>spring</plugin>
        </compilerPlugins>
      </configuration>
      <dependencies>
        <dependency>
          <groupId>org.jetbrains.kotlin</groupId>
          <artifactId>kotlin-maven-allopen</artifactId>
          <version>${kotlin.version}</version>
        </dependency>
      </dependencies>
    </plugin>

    Conclusion

    SpringFu is an exciting new project that enables us to write cleaner, more-readable code and offers more control for Spring-based applications. It builds on your existing Java/Kotlin knowledge, which makes the task of learning it a bit easier. One of the exciting goals is to able to write native applications using GraalVM. Be aware that some of the SpringFu components are not production-ready yet.

    Kotlin is an exciting new programming language especially if you are coming from a Java background. You can start your Kotlin journey by attending this coursera course.

    In addition, you might find these other Spring articles helpful.

    Last updated: January 29, 2019

    Recent Posts

    • How to run AI models in cloud development environments

    • How Trilio secures OpenShift virtual machines and containers

    • How to implement observability with Node.js and Llama Stack

    • How to encrypt RHEL images for Azure confidential VMs

    • How to manage RHEL virtual machines with Podman Desktop

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue