Check Out Our Amazing ROADMAPS
<?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 http://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 >3.0.2</version >
<relativePath /> <!-- lookup parent from repository -->
</parent >
<groupId >com.in28minutes.springboot.rest.example</groupId >
<artifactId >spring-boot-2-rest-service-exception-handling</artifactId >
<version >0.0.1-SNAPSHOT</version >
<packaging >jar</packaging >
<name >spring-boot-2-rest-service</name >
<description >Spring Boot 2 and REST - Example Project</description >
<properties >
<java .version>17</java .version>
</properties >
<dependencies >
<dependency >
<groupId >org.springframework.boot</groupId >
<artifactId >spring-boot-starter-actuator</artifactId >
</dependency >
<dependency >
<groupId >org.springframework.boot</groupId >
<artifactId >spring-boot-starter-data-jpa</artifactId >
</dependency >
<dependency >
<groupId >org.springframework.boot</groupId >
<artifactId >spring-boot-starter-web</artifactId >
</dependency >
<dependency >
<groupId >org.springframework.boot</groupId >
<artifactId >spring-boot-starter-hateoas</artifactId >
</dependency >
<dependency >
<groupId >org.springframework.boot</groupId >
<artifactId >spring-boot-devtools</artifactId >
<scope >runtime</scope >
</dependency >
<dependency >
<groupId >com.h2database</groupId >
<artifactId >h2</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 >
<repositories >
<repository >
<id >spring-milestones</id >
<name >Spring Milestones</name >
<url >https://repo.spring.io/milestone</url >
<snapshots >
<enabled >false</enabled >
</snapshots >
</repository >
</repositories >
<pluginRepositories >
<pluginRepository >
<id >spring-milestones</id >
<name >Spring Milestones</name >
<url >https://repo.spring.io/milestone</url >
<snapshots >
<enabled >false</enabled >
</snapshots >
</pluginRepository >
</pluginRepositories >
</project >
/src/main/java/com/in28minutes/springboot/rest/example/exception/CustomizedResponseEntityExceptionHandler.java
package com .in28minutes .springboot .rest .example .exception ;
import java .time .LocalDateTime ;
import org .springframework .http .HttpStatus ;
import org .springframework .http .ResponseEntity ;
import org .springframework .web .bind .annotation .ExceptionHandler ;
import org .springframework .web .bind .annotation .RestControllerAdvice ;
import org .springframework .web .context .request .WebRequest ;
import org .springframework .web .servlet .mvc .method .annotation .ResponseEntityExceptionHandler ;
import com .in28minutes .springboot .rest .example .student .StudentNotFoundException ;
@ RestControllerAdvice
public class CustomizedResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {
@ ExceptionHandler (Exception .class )
public final ResponseEntity <ExceptionResponse > handleAllExceptions (Exception exception , WebRequest request ) {
ExceptionResponse exceptionResponse = new ExceptionResponse (LocalDateTime .now (), exception .getMessage (),
request .getDescription (false ));
return new ResponseEntity <>(exceptionResponse , HttpStatus .INTERNAL_SERVER_ERROR );
}
@ ExceptionHandler (StudentNotFoundException .class )
public final ResponseEntity <ExceptionResponse > handleUserNotFoundException (StudentNotFoundException studentNotFoundException , WebRequest request ) {
ExceptionResponse exceptionResponse = new ExceptionResponse (LocalDateTime .now (), studentNotFoundException .getMessage (),
request .getDescription (false ));
return new ResponseEntity <>(exceptionResponse , HttpStatus .NOT_FOUND );
}
}
/src/main/java/com/in28minutes/springboot/rest/example/exception/ExceptionResponse.java
package com .in28minutes .springboot .rest .example .exception ;
import java .time .LocalDateTime ;
public record ExceptionResponse (LocalDateTime timestamp ,
String message ,
String details ) {
}
/src/main/java/com/in28minutes/springboot/rest/example/SpringBoot2RestServiceApplication.java
package com .in28minutes .springboot .rest .example ;
import org .springframework .boot .SpringApplication ;
import org .springframework .boot .autoconfigure .SpringBootApplication ;
@ SpringBootApplication
public class SpringBoot2RestServiceApplication {
public static void main (String [] args ) {
SpringApplication .run (SpringBoot2RestServiceApplication .class , args );
}
}
/src/main/java/com/in28minutes/springboot/rest/example/student/Student.java
package com .in28minutes .springboot .rest .example .student ;
import jakarta .persistence .Entity ;
import jakarta .persistence .GeneratedValue ;
import jakarta .persistence .Id ;
@ Entity
public class Student {
@ Id
@ GeneratedValue
private Long id ;
private String name ;
private String passportNumber ;
public Student () {
super ();
}
public Student (Long id , String name , String passportNumber ) {
super ();
this .id = id ;
this .name = name ;
this .passportNumber = passportNumber ;
}
public Long getId () {
return id ;
}
public void setId (Long id ) {
this .id = id ;
}
public String getName () {
return name ;
}
public void setName (String name ) {
this .name = name ;
}
public String getPassportNumber () {
return passportNumber ;
}
public void setPassportNumber (String passportNumber ) {
this .passportNumber = passportNumber ;
}
}
/src/main/java/com/in28minutes/springboot/rest/example/student/StudentNotFoundException.java
package com .in28minutes .springboot .rest .example .student ;
import org .springframework .http .HttpStatus ;
import org .springframework .web .bind .annotation .ResponseStatus ;
@ ResponseStatus (HttpStatus .NOT_FOUND )
public class StudentNotFoundException extends RuntimeException {
public StudentNotFoundException (String exception ) {
super (exception );
}
}
/src/main/java/com/in28minutes/springboot/rest/example/student/StudentRepository.java
package com .in28minutes .springboot .rest .example .student ;
import org .springframework .data .jpa .repository .JpaRepository ;
import org .springframework .stereotype .Repository ;
@ Repository
public interface StudentRepository extends JpaRepository <Student , Long > {
}
/src/main/java/com/in28minutes/springboot/rest/example/student/StudentResource.java
package com .in28minutes .springboot .rest .example .student ;
import static org .springframework .hateoas .server .mvc .WebMvcLinkBuilder .linkTo ;
import static org .springframework .hateoas .server .mvc .WebMvcLinkBuilder .methodOn ;
import java .net .URI ;
import java .util .List ;
import java .util .Optional ;
import org .springframework .beans .factory .annotation .Autowired ;
import org .springframework .hateoas .EntityModel ;
import org .springframework .hateoas .server .mvc .WebMvcLinkBuilder ;
import org .springframework .http .ResponseEntity ;
import org .springframework .web .bind .annotation .DeleteMapping ;
import org .springframework .web .bind .annotation .GetMapping ;
import org .springframework .web .bind .annotation .PathVariable ;
import org .springframework .web .bind .annotation .PostMapping ;
import org .springframework .web .bind .annotation .PutMapping ;
import org .springframework .web .bind .annotation .RequestBody ;
import org .springframework .web .bind .annotation .RequestMapping ;
import org .springframework .web .bind .annotation .RestController ;
import org .springframework .web .servlet .support .ServletUriComponentsBuilder ;
@ RestController
@ RequestMapping ("/students" )
public class StudentResource {
@ Autowired
private StudentRepository studentRepository ;
@ GetMapping ()
public List <Student > retrieveAllStudents () {
return studentRepository .findAll ();
}
@ GetMapping ("{id}" )
public EntityModel <Student > retrieveStudent (@ PathVariable long id ) {
Optional <Student > student = studentRepository .findById (id );
if (student .isEmpty ())
throw new StudentNotFoundException ("id-" + id );
EntityModel <Student > resource = EntityModel .of (student .get ());
WebMvcLinkBuilder linkTo = linkTo (methodOn (this .getClass ()).retrieveAllStudents ());
resource .add (linkTo .withRel ("all-students" ));
return resource ;
}
@ DeleteMapping ("{id}" )
public void deleteStudent (@ PathVariable long id ) {
studentRepository .deleteById (id );
}
@ PostMapping ()
public ResponseEntity <Object > createStudent (@ RequestBody Student student ) {
Student savedStudent = studentRepository .save (student );
URI location = ServletUriComponentsBuilder .fromCurrentRequest ().path ("/{id}" )
.buildAndExpand (savedStudent .getId ()).toUri ();
return ResponseEntity .created (location ).build ();
}
@ PutMapping ("/{id}" )
public ResponseEntity <Object > updateStudent (@ RequestBody Student student , @ PathVariable long id ) {
Optional <Student > studentOptional = studentRepository .findById (id );
if (studentOptional .isEmpty ())
return ResponseEntity .notFound ().build ();
student .setId (id );
studentRepository .save (student );
return ResponseEntity .noContent ().build ();
}
}
/src/main/resources/application.properties
/src/main/resources/data.sql
insert into student
values(10001,'Ranga', 'E1234567');
insert into student
values(10002,'Ravi', 'A1234568');
/src/test/java/com/in28minutes/springboot/rest/example/SpringBoot2RestServiceApplicationTests.java
package com .in28minutes .springboot .rest .example ;
import org .junit .jupiter .api .Test ;
import org .junit .jupiter .api .extension .ExtendWith ;
import org .springframework .boot .test .context .SpringBootTest ;
import org .springframework .test .context .junit .jupiter .SpringExtension ;
// replaced @RunWith with @ExtendWith
// replaced SpringRunner.class with SpringExtension.class
@ ExtendWith (SpringExtension .class )
@ SpringBootTest
public class SpringBoot2RestServiceApplicationTests {
@ Test
public void contextLoads () {
}
}