Spring Data JPA Like and Containing Example

In this tutorial, we will see Spring Data JPA Like and Containing Example using Spring Boot and oracle. We will see what query prepared in both cases with example.

Let’s see how to define the Query method(Query creation from method names) using Spring Data JPA Like and Containing Keywords.

Consider we have an entity called Student.java as below.

package com.netsurfingzone.entity;

@Entity
public class Student {

	@Id
	@GeneratedValue(strategy = GenerationType.AUTO)
	private int id;

	@Column(name = "name")
	private String name;

	@Column(name = "roll_number")
	private String rollNumber;

	@Column(name = "university")
	String university;
	

}

 

and we have some record in the database as below.

Spring Data JPA Like and Containing

 

Query method using Like.

public List<Student> findByNameLike(String name);


Generated Query.

Hibernate:
select
student0_.id as id1_0_,
student0_.name as name2_0_,
student0_.roll_number as roll_number3_0_,
student0_.university as university4_0_
from
student student0_
where
student0_.name like ?

 

Spring Data JPA Like and Containing

In the above screenshot did you notice [john] is there as a binding parameter. You might be expecting [%john%] in the generated query. If you want [%john%] we need to define the query method using Containing keyword. See below example for more details.

Query method using Containing.

public List<Student> findByNameContaining(String name);

Generated Query.

 

Hibernate:
select
student0_.id as id1_0_,
student0_.name as name2_0_,
student0_.roll_number as roll_number3_0_,
student0_.university as university4_0_
from
student student0_
where
student0_.name like ?


Spring Data JPA Like and Containing

 

 

Note – For both Like and Containing generated queries are same using spring.jpa.show-sql = true. When we use logging.level.org.hibernate.type.descriptor.sql = TRACE in the application.properties file then we can see how value(binding parameter) is getting passed in both cases.

 

Repository Example.

package com.netsurfingzone.repository;

import java.io.Serializable;
import java.util.List;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

import com.netsurfingzone.entity.Student;

@Repository
public interface StudentRepository extends JpaRepository<Student, Serializable> {

	public List<Student> findByNameLike(String name);
	
	public List<Student> findByNameNotLike(String name);
	
	public List<Student> findByNameContaining(String name);

}

 

Spring Data JPA Like and Containing example using Spring Boot and oracle.

Open eclipse and create maven project, Don’t forget to check ‘Create a simple project (skip)’ click on next.  Fill all details(GroupId – springdatalike, ArtifactId – springdatalike and name – springdatalike) and click on finish. Keep packaging as the jar.

Modify pom.xml

<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>springdatalike</groupId>
	<artifactId>springdatalike</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>springdatalike</name>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.2.RELEASE</version>
	</parent>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>

		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-jpa</artifactId>
		</dependency>

		<dependency>
			<groupId>com.oracle</groupId>
			<artifactId>ojdbc6</artifactId>
			<version>11.2.0.3</version>
		</dependency>

	</dependencies>
	<build>
		<finalName>${project.artifactId}</finalName>
		<plugins>

			<plugin>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.1</version>
				<configuration>
					<fork>true</fork>
					<executable>C:\Program Files\Java\jdk1.8.0_131\bin\javac.exe</executable>
				</configuration>
			</plugin>


		</plugins>
	</build>
</project>

Note – In pom.xml we have defined javac.exe path in configuration tag. You need to change accordingly i.e where you have installed JDK.

If you see any error for oracle dependency then follow these steps.

Directory structure –

Spring Data JPA Like and Containing

 

 

Student.java


package com.netsurfingzone.entity;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Student {

	@Id
	@GeneratedValue(strategy = GenerationType.AUTO)
	private int id;

	@Column(name = "name")
	private String name;

	@Column(name = "roll_number")
	private String rollNumber;

	@Column(name = "university")
	String university;

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getRollNumber() {
		return rollNumber;
	}

	public void setRollNumber(String rollNumber) {
		this.rollNumber = rollNumber;
	}

	public String getUniversity() {
		return university;
	}

	public void setUniversity(String university) {
		this.university = university;
	}

}

StudentController.java

package com.netsurfingzone.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import com.netsurfingzone.entity.Student;
import com.netsurfingzone.service.StudentService;

@RestController
@RequestMapping(value = "/student")
public class StudentController {

	@Autowired
	private StudentService studentService;

	@RequestMapping(value = "/saveall", method = RequestMethod.POST)
	@ResponseBody
	public List<Student> saveAllStudents(@RequestBody List<Student> studentList) {
		List<Student> studentResponse = (List<Student>) studentService.saveAllStudent(studentList);
		return studentResponse;
	}

	@RequestMapping(value = "/like/{name}", method = RequestMethod.GET)
	@ResponseBody
	public List<Student> findByNameLike(@PathVariable String name) {

		List<Student> studentResponse = (List<Student>) studentService.findByNameLike(name);
		return studentResponse;
	}

	@RequestMapping(value = "/notlike/{name}", method = RequestMethod.GET)
	@ResponseBody
	public List<Student> findByNameNotLike(@PathVariable String name) {

		List<Student> studentResponse = (List<Student>) studentService.findByNameNotLike(name);
		return studentResponse;
	}

	@RequestMapping(value = "/containing/{name}", method = RequestMethod.GET)
	@ResponseBody
	public List<Student> findByNameContaining(@PathVariable String name) {

		List<Student> studentResponse = (List<Student>) studentService.findByNameContaining(name);
		return studentResponse;
	}

}

 

Note – See more details about @Controller and RestController here.

StudentRepository.java – interface

package com.netsurfingzone.repository;

import java.io.Serializable;
import java.util.List;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

import com.netsurfingzone.entity.Student;

@Repository
public interface StudentRepository extends JpaRepository<Student, Serializable> {

	public List<Student> findByNameLike(String name);

	public List<Student> findByNameNotLike(String name);

	public List<Student> findByNameContaining(String name);

}

StudentService.java – interface

package com.netsurfingzone.service;

import java.util.List;

import org.springframework.stereotype.Component;

import com.netsurfingzone.entity.Student;

@Component
public interface StudentService {
	public List<Student> saveAllStudent(List<Student> studentList);

	public List<Student> findByNameLike(String rollnumber);

	public List<Student> findByNameNotLike(String rollnumber);

	public List<Student> findByNameContaining(String name);

}

Note – See here more about @Component, @Controller, @Service and @Repository annotations here.


StudentServiceImpl.java

package com.netsurfingzone.impl;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import com.netsurfingzone.entity.Student;
import com.netsurfingzone.repository.StudentRepository;
import com.netsurfingzone.service.StudentService;

@Service("studentServiceImpl")
public class StudentServiceImpl implements StudentService {

	@Autowired
	private StudentRepository studentRepository;

	@Transactional
	public List<Student> saveAllStudent(List<Student> studentList) {
		List<Student> response = (List<Student>) studentRepository.saveAll(studentList);
		return response;
	}

	@Transactional
	public List<Student> findByNameLike(String name) {
		List<Student> response = (List<Student>) studentRepository.findByNameLike(name);
		return response;
	}

	@Transactional
	public List<Student> findByNameNotLike(String name) {
		List<Student> response = (List<Student>) studentRepository.findByNameNotLike(name);
		return response;
	}

	@Transactional
	public List<Student> findByNameContaining(String name) {
		List<Student> response = (List<Student>) studentRepository.findByNameContaining(name);
		return response;
	}
}

SpringMain.java

package com.netsurfingzone.main;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
@ComponentScan(basePackages = "com.*")
@EntityScan("com.netsurfingzone.entity")
public class SpringMain {
	public static void main(String[] args) {

		SpringApplication.run(SpringMain.class, args);
	}

}

Note – See more details about @ComponentScan here.

JpaConfig.java

package com.netsurfingzone.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

@Configuration
@EnableJpaRepositories(basePackages = "com.netsurfingzone.repository")
public class JpaConfig {

}

Note – See more details about @Configuration annotations here.

application.properties

# Connection url for the database
spring.datasource.url=jdbc:oracle:thin:@localhost:1521:XE
spring.datasource.username=SYSTEM
spring.datasource.password=oracle2
spring.datasource.driver-class-name=oracle.jdbc.driver.OracleDriver
# Show or not log for each sql query
spring.jpa.show-sql = true
spring.jpa.properties.hibernate.format_sql=true 
 
spring.jpa.hibernate.ddl-auto =create
spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.Oracle10gDialect
 
server.port = 9091

#show sql values
logging.level.org.hibernate.type.descriptor.sql=trace

#hibernate.show_sql = true
#spring.jpa.hibernate.logging.level.sql =FINE
#show sql statement
#logging.level.org.hibernate.SQL=debug

Let’s run the SpringMain class(run as java application).

Perform saveall operation first using below REST API.

http://localhost:9091/student/saveall

[
    {
        "name": "john",
        "rollNumber": "120",
        "university":"rgtu"
    },
    {
        "name": "johnpoul",
        "rollNumber": "121",
        "university":"rgtu"
    },
    {
        "name": "aricjohn",
        "rollNumber": "123",
        "university":"rgtu"
    },
    {
        "name": "hira",
        "rollNumber": "124",
        "university":"rgtu"
    }
    
    
]

 

Response Data.

[
    {
        "id": 1,
        "name": "john",
        "rollNumber": "120",
        "university": "rgtu"
    },
    {
        "id": 2,
        "name": "johnpoul",
        "rollNumber": "121",
        "university": "rgtu"
    },
    {
        "id": 3,
        "name": "aricjohn",
        "rollNumber": "123",
        "university": "rgtu"
    },
    {
        "id": 4,
        "name": "hira",
        "rollNumber": "124",
        "university": "rgtu"
    }
]

 

http://localhost:9091/student/like/john

 

http://localhost:9091/student/containing/john

 

 

That’s all about Spring Data JPA greater than and greater than equal example using Spring Boot and oracle

 

You may like.

 

Other Spring Data JPA and Hibernate tutorials.

 

Spring Data JPA Docs.