Spring JDBC API + Azure SQL Database - Build REST CRUD APIs

In this section, we will learn how to build REST CRUD APIs with Spring Boot, Spring JDBC API and Microsoft Azure SQL Database.

A little bit of Background

Azure SQL Database

Azure SQL Database is a fully managed platform as a service (PaaS) database engine that handles most of the database management functions such as upgrading, patching, backups, and monitoring without user involvement. Azure SQL Database is always running on the latest stable version of the SQL Server database engine and patched OS with 99.99% availability. PaaS capabilities built into Azure SQL Database enable you to focus on the domain-specific database administration and optimization activities that are critical for your business.

Spring Boot

Spring Boot makes it easy to create stand-alone, production-grade Spring-based Applications that you can "just run". 
More Info - Spring Boot


Spring JDBC API

The Spring Jdbc API is an adaptation of the standard JDBC API. It is very easy to get started using Spring Jdbc, and the API includes many useful methods that will map data to classes that Java developers use on a regular basis.

After completing this tutorial what we will build? 

We will build REST APIs  CRUD features: 


Step 1: Sign in to Azure Portal and create a resource group

Sign in to Azure portal https://portal.azure.com/#home and find "Resource groups" like below.



Then, create a resource group like the one below.


Here the resource group name is "Knowledgefactory". Create a resource group by clicking the "Review + create " button.


Step 2: Create an Azure SQL Database

Select "Azure SQL",

You will be taken to a page like the below image, Then click on the "Create Azure SQL resource" button.

Next, Select the SQL deployment option,
Select Resource type as Database server and then click on the "Create" button.

You will be taken to a page like the below image, 
Select/Enter necessary information like the above image and then, click on the "Review + create" button. Don't forget to keep the "Server admin login" name and "Password" somewhere safe.

Then click on the "Create" button.

Now, You can see "Deployment is in progress" like the below image.

Once deployment is completed you can see the "Your deployment is complete" page like the below image.

Then, click on the "Go to resource" button, and you will be taken to a page like the below image, 
Then, click on "Create database"

Create SQL Database,

Then, click on the "Review + create" button,

Then click on the "Create" button. You can see "Deployment is in progress"

Once deployment is completed you can see the "Your deployment is complete" page like the below image.

Click on the "Connection strings",
Copy it and keep it safe for future purposes.

Whitelisting IP Address for Access to Azure SQL DB, like the below image
Then click on the "Save" button


Step 3: Creating a simple spring boot web application

First, open the Spring initializr https://start.spring.io/

Then, Provide the Group and Artifact name. We have provided Group name com.knf.dev.demo and Artifact spring-jdbc-api-azure-sql-crud. Here I selected the Maven project - language Java - Spring Boot 2.7.3 and add Spring web dependency, MS SQL Server Driver, and JDBC API. 




Then, click on the Generate button. When we click on the Generate button, it starts packing the project in a .zip(spring-jdbc-api-azure-sql-crud.zip) file and downloads the project. 
Then, Extract the Zip file.

Import the project on your favourite IDE,

Final Project Directory:



Pom.xml

A Project Object Model or POM is the fundamental unit of work in Maven. It is an XML file that contains information about the project and configuration details utilized by Maven to build the project. 

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
   https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.7.4</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>
   <groupId>com.knf.dev.demo</groupId>
   <artifactId>spring-jdbc-api-azure-sql-crud</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>spring-jdbc-api-azure-sql-crud</name>
   <description>Demo project for Spring Boot</description>
   <properties>
      <java.version>17</java.version>
   </properties>
   <dependencies>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-jdbc</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
      </dependency>

      <dependency>
         <groupId>com.microsoft.sqlserver</groupId>
         <artifactId>mssql-jdbc</artifactId>
         <scope>runtime</scope>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>
   </dependencies>

   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>

</project>



schema.sql: Creating a table for 'users'

Spring Boot can automatically create the schema (DDL scripts) of your DataSource and initialize it (DML scripts). It loads SQL from the standard root classpath locations: schema. sql and data. sql , respectively.
DROP TABLE IF EXISTS users;

CREATE TABLE users (
    id INT IDENTITY PRIMARY KEY,
    first_name VARCHAR ( 50 )  NOT NULL,
    last_name VARCHAR ( 50 ) NOT NULL,
    email VARCHAR ( 255 )  NOT NULL
);


application.properties

The following properties are needed to configure Azure SQL with Spring Boot. 

The property spring.datasource.initialization-mode from Spring boot verion 2.7 and onwards is not any more depracated. It has been completely removed! So the change into the replacement property spring.sql.init.mode is a must do from now on.
Example: spring.sql.init.mode=always
logging.level.org.springframework.jdbc.core=DEBUG

spring.datasource.url=jdbc:sqlserver://<servername>.database.windows.net:1433;database=demo_db;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;
spring.datasource.username=<username>
spring.datasource.password=<password>

spring.sql.init.mode=always
**Important note** Do not publish the fields directly for security. It would be a good choice to define these variables as environment variables or use the Azure Key Vault. 


Creating the Model User

package com.knf.dev.demo.model;

public record User
        (Long id,
         String firstName,
         String lastName,
         String email) {
}



Creating the User Repository

package com.knf.dev.demo.repository;

import com.knf.dev.demo.model.User;
import java.util.List;

public interface UserRepository {

    public User findOne(Long id);

    public List<User> findAll();

    public void save(User user);

    public Long saveAndReturnId(User user);

    public void update(User user);

    public Boolean delete(Long id);

}



Creating the User Repository Implementation

package com.knf.dev.demo.repository;

import com.knf.dev.demo.exception.UserNotFound;
import com.knf.dev.demo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.support.GeneratedKeyHolder;
import org.springframework.stereotype.Repository;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;

@Repository
public class UserRepositoryImpl implements UserRepository {

    private final JdbcTemplate jdbcTemplate;

    @Autowired
    public UserRepositoryImpl(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }


    @Override
    public User findOne(Long id) {

        var sqlQuery = Query.FIND_ONE;

        try {

            return jdbcTemplate.
                    queryForObject(sqlQuery,
                            this::mapRowToUser, id);

        } catch (EmptyResultDataAccessException ex) {
            throw new UserNotFound("Invalid User Id");
        }
    }

    @Override
    public List<User> findAll() {

        var sqlQuery = Query.FIND_ALL;
        return jdbcTemplate.
                query(sqlQuery, this::mapRowToUser);
    }

    @Override
    public void save(User user) {

        var sqlQuery = Query.SAVE;
        jdbcTemplate.update(sqlQuery,
                user.firstName(),
                user.lastName(),
                user.email());
    }

    @Override
    public Long saveAndReturnId(User user) {

        var sqlQuery = Query.SAVE_AND_RETURN_ID;
        var keyHolder = new GeneratedKeyHolder();
        jdbcTemplate.update(connection -> {
            PreparedStatement stmt = connection.
                    prepareStatement(sqlQuery,
                            new String[] { "id" });

            stmt.setString(1, user.firstName());
            stmt.setString(2, user.lastName());
            stmt.setString(3, user.email());

            return stmt;

        }, keyHolder);

        return keyHolder.getKey().longValue();
    }

    @Override
    public void update(User user) {

        var sqlQuery = Query.UPDATE;
        jdbcTemplate.update(sqlQuery,
                user.firstName(),
                user.lastName(),
                user.email(),
                user.id());
    }

    @Override
    public Boolean delete(Long id) {

        var sqlQuery = Query.DELETE;
        return jdbcTemplate.update(sqlQuery, id) > 0;
    }

    private User mapRowToUser(ResultSet resultSet, int rowNum)
            throws SQLException {

        var user = new User(resultSet.getLong("id"),
                resultSet.getString("first_name"),
                resultSet.getString("last_name"),
                resultSet.getString("email"));

        return user;
    }
}



Query.java

package com.knf.dev.demo.repository;

public class Query {

    public static final String FIND_ONE = 
            "select id, first_name, last_name,"
                + " email from users where id = ?";
    
    public static final String FIND_ALL =
            "select id, first_name,last_name,"
              + " email from users";
    
    public static final String SAVE =
            "insert into users(first_name, "
                + "last_name, email) "
                  + "values (?, ?, ?)";
    
    public static final String SAVE_AND_RETURN_ID =
            "insert into users" 
               + "(first_name, last_name, email) "
                   + "values (?, ?, ?)";
    public static final String UPDATE =
           "update users set " 
              + "first_name = ?, last_name = ?," 
                   + " email = ? " + "where id = ?";
    public static final String DELETE =
          "delete from users where id = ?";
}



Exception Handler with Controller Advice in Spring

Spring supports exception handling by a global Exception Handler (@ExceptionHandler) with Controller Advice (@ControllerAdvice). This enables a mechanism that makes ResponseEntity work with the type safety and flexibility of @ExceptionHandler:
package com.knf.dev.demo.exception;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.context.request.WebRequest;

import java.util.Date;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(UserNotFound.class)
    public ResponseEntity<ErrorMessage>
    userNotFound(Exception ex, WebRequest request) {
        var errors =
         new ErrorMessage(404, new Date(),
           ex.getMessage(), "User Not Found");

        return new ResponseEntity<>
            (errors, HttpStatus.NOT_FOUND);
    }
}



Custom Exception - UserNotFound

package com.knf.dev.demo.exception;

public class UserNotFound extends RuntimeException {
    private static final long serialVersionUID = 1L;

    public UserNotFound(String msg) {
        super(msg);
    }
}



Error Message

package com.knf.dev.demo.exception;

import java.util.Date;

public record ErrorMessage
(Integer statusCode, 
        Date timestamp, 
          String message,
            String description) {
}



User Rest Controller

The @RestController annotation was introduced in Spring 4.0 to simplify the engendering of RESTful web services. It's a convenience annotation that combines @Controller and @ResponseBody. @RequestMapping annotation maps HTTP requests to handler methods of MVC and REST controllers.
package com.knf.dev.demo.controller;

import com.knf.dev.demo.model.User;
import com.knf.dev.demo.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import java.util.List;

@RestController
@RequestMapping("/api/v1/users")
public class UserController {

    @Autowired
    UserRepository userRepository;

    //Create user
    @PostMapping
    public ResponseEntity<String> save(@RequestBody User usr) {

            var userId = userRepository.saveAndReturnId(usr);

            return new ResponseEntity<String>
             ("User successfully created , Id =" 
                + userId, HttpStatus.CREATED);

    }

    //Get all users
    @GetMapping
    public ResponseEntity<List<User>> getAll() {

            return new ResponseEntity<List<User>>
              (userRepository.findAll(), HttpStatus.OK);

    }

    //Get user by id
    @GetMapping("/{id}")
    public ResponseEntity<User> getById
        (@PathVariable("id") Long id) {

        return new ResponseEntity<>
           (userRepository.findOne(id), HttpStatus.OK);

    }

    // Delete user
    @DeleteMapping("/{id}")
    public ResponseEntity<String> deleteUser
         (@PathVariable("id") Long id) {

        userRepository.delete(userRepository.findOne(id).id());

        return new ResponseEntity<>
           ("User removed successfully", HttpStatus.OK);

    }

    // Update user
    @PutMapping("/{id}")
    public ResponseEntity<String> updateUser
       (@PathVariable("id") Long id, @RequestBody User user) {

        var _user = userRepository.findOne(id);
        var _upUSer = new User(_user.id(),
                user.firstName(),user.lastName(),user.email());
        
        userRepository.update(_upUSer);
        return new ResponseEntity<>
           ("Updated successfully", HttpStatus.OK);

    }
}



Spring Boot main driver

package com.knf.dev.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

   public static void main(String[] args) {
      SpringApplication.run(Application.class, args);
   }

}



Step 4: Local Setup and Run the application

Step 1: Download or clone the source code from GitHub to the local machine - Click here


Step 2: mvn clean install


Step 3: Run the Spring Boot application - 

mvn spring-boot:run



Step 5: Test the APIs using postman

1. Add User:


2. Get User By Id:


3. Update User:


4. Get All Users:


5. Delete User:

Download the complete source code - click here

Popular posts from this blog

Learn Java 8 streams with an example - print odd/even numbers from Array and List

Example 1: Java 8 program to print odd numbers from a List   import java.util.Arrays; import java.util.List; import java.util.stream.Collectors; /*Java 8 Program to find Odd Numbers from a List*/ public class DriverClass { public static void main( String [] args) { List < Integer > numbers = Arrays. asList( 1 , 4 , 8 , 40 , 11 , 22 , 33 , 99 ); List < Integer > oddNumbers = numbers.stream(). filter(o -> o % 2 != 0 ). collect(Collectors.toList()); System.out.println(oddNumbers); } } 1. Initialize List using Arrays.asList() method. Java's built-in Arrays.asList() method converts an array into a list. This method takes an array as an argument and returns a List object. 2.  Java List interface provides stream() method which returns a sequential Stream with list of Integer as its source. 3. The Java stream filter() method allow
Read more

Java Stream API - How to convert List of objects to another List of objects using Java streams?

Image
In this section, we will show you how to convert a List of objects to another List of objects in Java using the Java streams map(). The ‘map’ method maps each element to its corresponding result. Java Stream API   The Java Stream API provides a functional programming approach over the object oriented capabilities of Java. It is used for processing collections of objects. The Stream in Java can be defined as a sequence of elements from a source List, Set or Array. Most of the stream operations return a Stream. This avails engender a chain of stream operations(stream pipe-lining). The streams withal support the aggregate or terminal operations on the elements. for example, finding the sum or maximum element or finding the average etc...Stream operations can either be executed sequentially or parallel. when performed parallelly, it is called a parallel stream.   Stream map() Method   The Java 8 Stream map() is an intermediate operation. It converts Stream<obj1> to Stream<obj2>
Read more

Registration and Login with Spring Boot + Spring Security + Thymeleaf

Image
In this section, we will learn how to create user registration and login using Spring boot, Spring security, Thymeleaf, JPA, and H2DB. The GitHub repository link is provided at the end of this tutorial. You can download the source code. Technologies used: Spring Boot 2.5.5  Spring Data JPA  Spring Security  Thymeleaf  Maven 3+  Java 17  H2 Database   User Interface User Registration Authentication Failed Authentication success Sign out Final Project Structure: Complete pom.xml: <? xml version ="1.0" encoding ="UTF-8" ?> < project xmlns ="http://maven.apache.org/POM/4.0.0" xmlns: xsi ="http://www.w3.org/2001/XMLSchema-instance" xsi :schemaLocation ="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" > < modelVersion >4.0.0</ modelVersion > < parent > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-pare
Read more

Java, Spring Boot Mini Project - Library Management System - Download

Image
Hello everyone, Hope you are doing well. Here, we provide a Library Management System mini-project for beginners, it's free for download. Maybe you can build more on top of this project and create your own product, that's all about you. The source code download link is provided at the end of this post. 1. Benefit of this project You could cover the following technologies and features by learning and debugging this mini project. Java 17 Java Stream Java Lamda Expressions Java Records Functional programming Object-oriented programming var Keyword in Java Generics in Java Java Switch Spring boot 2.6.4 Spring Security Thymeleaf template engine OpenCSV Spring Data JPA Server Side Pagination H2 Database  Bootstrap HTML CSS and more... 2. Objective Of Spring Boot On Library Management System The main objective of this project is to manage the details of the books, author, category, and publisher. Only Admin/Librarian will manage all these activities. Also, they can export the data in
Read more

ReactJS, Spring Boot JWT Authentication Example

Image
In this tutorial, we’ll create a user registration & login example using ReactJS, Spring Boot, Spring Security, and JWT authentication. You could download the source code from our Github repository, the download link is provided at the end of this tutorial. Technologies used Backend Technologies: Java 17 Spring Boot 2.7.0 Spring Security Spring Data JPA JWT H2 Database Frontend Technologies: React 17.0.1 Axios 0.27.2 Redux 4.0.5 Bootstrap 4.5.2 ReactJS - SpringBoot - JWT - Flow Backend Project Directory: Frontend Project Directory: Following is the screenshot of our application - User Registration: User Signin: Profile View: Access Resource: We will build two projects:  1. Backend:   spring-boot-security-jwt 2. Frontend: react-redux-jwt Project 1: spring-boot-security-jwt Pom.xml <?xml version = "1.0" encoding = "UTF-8" ?> <project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
Read more

Top 5 Java ORM tools - 2024

Image
  The term ORM refers to object-relational mapping, which uses objects to adapt programming languages to database systems while allowing them to function with SQL and object-oriented programming ideas. Any kind of database management system that can accomplish object mapping to the table in the virtual system is suitable for the implementation of ORM. Java has a wide variety of ORM tools, some of which are mentioned below: 1. Hibernate Hibernate is a lightweight, open-source, non-invasive Java ORM (Object-Relational Mapping) framework that allows developers to create objects that function independently of database software and create persistence logic in any Java or JavaEE application. It offers an abstraction layer, so developers don't have to bother about implementations; Hibernate handles these tasks internally, such as connecting to databases and creating queries to carry out CRUD operations, among other things. Persistence logic development is done with it. Persistence logic r
Read more

Java - Blowfish Encryption and decryption Example

Image
Blowfish is an encryption method developed by Bruce Schneier in 1993 as an alternative to the DES encryption method. It is significantly faster than DES and provides good encryption speed, although no effective cryptanalysis technique has been found to date. It is one of the first secure block ciphers that is not protected by any patents and is therefore freely available for anyone to use. This is a symmetric block cipher algorithm. Block size: 64 bits Key size: variable size from 32 to 448 bits number of subsections: 18 [P-array] number of rounds: 16 number of substitution blocks: 4 [each with 512 records of 32 bits each] develop  Example 1: Encryption and decryption using Blowfish import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.security.InvalidKeyException; import java.security.NoSuchAlgorithmException; import java.util.Base64; import javax.crypto.BadPaddingException; import javax.crypto.Cipher; import javax.crypto.IllegalBlockSizeExc
Read more

Spring boot video streaming example-HTML5

Image
Hello everyone, Today we will learn how to stream MP4 video using Spring Boot and Spring Web Flux.  The Source code download link is provided at the end of this post. New, Quarkus Practice User Interface   Project Structure: G radle(build.gradle) plugins { id 'org.springframework.boot' version '2.5.4' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.knf.demo' version = '0.0.1-SNAPSHOT' sourceCompatibility = '11' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-webflux' testImplementation 'org.springframework.boot:spring-boot-starter-test' testImplementation 'io.projectreactor:reactor-test' } test { useJUnitPlatform() } Service (VideoStreamingService.java) package  com.knf.demo.service ; import org.springframework.beans.factory.annotation. Autowired ; import org.springframework
Read more

Google Cloud Storage + Spring Boot - File Upload, Download, and Delete

Image
In this section, we will learn  how to  create a simple spring boot application to perform different file operations such as upload, download, list, and delete files from the Google Cloud Storage. 1.  A little bit of Background Google Cloud Storage Cloud Storage is a managed service for storing unstructured data. Store any amount of data and retrieve it as often as you like. More Info - click here! Spring Boot Spring Boot makes it easy to create stand-alone, production-grade Spring-based Applications that you can "just run".  More Info - click here! 2. Create a GCP Project First, Sign into the Google console at  https://console.cloud.google.com . You can create a new project by first selecting the project dropdown in the top left and selecting " New Project ". Next, specify your GCP  Project name  and  Project ID . Then  Click on the " CREATE " button. Copy " Project ID " and keep it for future purposes. 3. Create a Google Cloud Storage bucket Fr
Read more