Lab11 - Mini Todo Management Project Using Spring Boot + Spring MVC + Spring Security + JSP + Hibernate + MySQL

Lab 11 : Mini Todo Management Project using Spring Boot +
Spring MVC + Spring Security + JSP + Hibernate + MySQL

In this article, we will learn how to develop Spring MVC Todo Management web application
using Spring Boot, Spring MVC, Spring Security, JSP, JPA and MySQL as a database.
This mini project is mainly for beginners to learn how to develop Spring MVC web applications
step by step using Spring Boot.
The following features are implemented in this mini todo management project:
 Create Todo
 Update Todo
 Delete Todo
 List Todo
 Get Todo by id.
 Simple Spring security
 Webjars to manage client-side dependencies(CSS and JS).
 JSP as view and common header, footer, and navigation bar.
 Custom error page mapping
You can implement the following features to this Todo Management project(take this is an
exercise):
 Finish Todo feature

 logging
 Role-based spring security
 Exception handling
 Validation
 Auditing
Lab 11 : Mini Todo Management Project using Spring Boot + Spring MVC + Spring Security + JSP +
Hibernate + MySQL -1
What we’ll build
We will develop step by step Spring MVC Todo management web application using Spring
Boot, Spring MVC, Spring Security, JSP, JPA and MySQL as a database.
Lab Objectives
After complete this lab, you will able to:
1. Creating and Importing a Project
2. Packaging Structure
3. Create the JPA Entity - Todo.java
4. Spring Data JPA Repository Interface - TodoRepository.java
5. Spring Security Configuration - SecurityConfiguration.java
6. Controller Layer - TodoController.java
7. Controller Layer - WelcomeController.java
8. Controller Layer - ErrorController.java
9. Controller Layer - LogoutController.java
10. Service Layer - ITodoService.java
11. Service Layer - TodoService.java
12. Configuring MySQL Database and JSP View Resolver
13. Common JSP page fragments - footer.jspf, header.jspf and navigation.jspf
14. Running the Application
15. Demo
Tools and Technologies Used
 Spring Boot - 2.0.4.RELEASE

 JDK - 1.8 or later
 Spring Framework - 5.0.8 RELEASE
 Hibernate - 5.2.17.Final
 Maven - 3.2+
 Spring Data JPA - 2.0.10 RELEASE
 IDE - Eclipse or Spring Tool Suite (STS)
 MYSQL - 5.1.47
 Spring Security - 5.0.7 RELEASE
 JSP
Lab Procedures
1. Creating and Importing a Project
There are many ways to create a Spring Boot application. The simplest way is to use Spring
Initializr at http://start.spring.io/, which is an online Spring Boot application generator.
Look at the above diagram, we have specified the following details:
 Generate: Maven Project

 Java Version: 1.8 (Default)
 Spring Boot:2.0.4
 Group: net.guides.todo
 Artifact: todo-management-spring-boot
 Name: todo-management-spring-boot
 Description: todo-management-spring-boot
 Package Name : net.guides.springboot.todomanagement
 Packaging: jar (This is the default value)
 Dependencies: Web, JPA, MySQL, DevTools, Security
Once, all the details are entered, click on Generate Project button will generate a spring boot
project and downloads it. Next, Unzip the downloaded zip file and import it into your favorite
IDE.
2. Packaging Structure
Following is the packing structure for your reference –
The pom.xml File
<?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>
<groupId>net.guides.springboot</groupId>
<artifactId>todo-management-spring-boot</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>todo-management-spring-boot</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.4.RELEASE</version>
<relativePath />

</parent>
<properties>
<project.build.sourceEncoding>UTF-
8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-
8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>bootstrap</artifactId>
<version>3.3.6</version>
</dependency>
<dependency>
<artifactId>bootstrap-datepicker</artifactId>
</dependency>
<dependency>
<artifactId>jquery</artifactId>
</dependency>
<dependency>
<groupId>org.apache.tomcat.embed</groupId>
<artifactId>tomcat-embed-jasper</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
Note that we have used Spring Data JPA starter to talk to MySQL database.
3. Create the JPA Entity - Todo.java
package net.guides.springboot.todomanagement.model;
import java.util.Date;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.validation.constraints.Size;
/**
* @author Ramesh Fadatare
*
*/
@Entity
@Table(name = "todos")
public class Todo {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private long id;
private String userName;
@Size(min = 10, message = "Enter at least 10 Characters...")
private String description;
private Date targetDate;
public Todo() {
super();
}
public Todo(String user, String desc, Date targetDate, boolean

isDone) {
super();
this.userName = user;
this.description = desc;
this.targetDate = targetDate;
}
public long getId() {

return id;
}
public void setId(long id) {

this.id = id;
}
public String getUserName() {

return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getDescription() {

return description;
}
public void setDescription(String description) {

this.description = description;
}
public Date getTargetDate() {

return targetDate;
}
public void setTargetDate(Date targetDate) {

this.targetDate = targetDate;
}
}
Next, create the Spring Data JPA repository for the Todo entity.
4. Spring Data JPA Repository Interface - TodoRepository.java
package net.guides.springboot.todomanagement.repository;
import java.util.List;
import org.springframework.data.jpa.repository.JpaRepository;
import net.guides.springboot.todomanagement.model.Todo;
public interface TodoRepository extends JpaRepository < Todo, Long >

{
List < Todo > findByUserName(String user);
}
5. Spring Security Configuration - SecurityConfiguration.java
package net.guides.springboot.todomanagement.security;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import
org.springframework.security.config.annotation.authentication.builder
s.AuthenticationManagerBuilder;
import
org.springframework.security.config.annotation.web.builders.HttpSecur
ity;
import
org.springframework.security.config.annotation.web.configuration.WebS
ecurityConfigurerAdapter;
import
org.springframework.security.crypto.password.NoOpPasswordEncoder;
@Configuration
public class SecurityConfiguration extends
WebSecurityConfigurerAdapter {
@Autowired
public void configureGlobalSecurity(AuthenticationManagerBuilder
auth)
throws Exception {
auth.inMemoryAuthentication()
.passwordEncoder(NoOpPasswordEncoder.getInstance())
.withUser("admin").password("admin")
.roles("USER", "ADMIN");
}
@Override
protected void configure(HttpSecurity http) throws Exception {
http.authorizeRequests().antMatchers("/login", "/h2-
console/**").permitAll()
.antMatchers("/",
"/*todo*/**").access("hasRole('USER')").and()
.formLogin();
http.csrf().disable();
http.headers().frameOptions().disable();
}
}
This class extends WebSecurityConfigurerAdapter and overrides a couple of its methods to set
some specifics of the web security configuration.
The configure(HttpSecurity) method defines which URL paths should be secured and which
should not. Specifically, the "/" and "/login" paths are configured to not require any authentication.
All other paths must be authenticated.
As for the userDetailsService() method, it sets up an in-memory user store with a single user. That
user is given a username of "admin", a password of "admin", and a role of "ADMIN".
6. Controller Layer - TodoController.java
This class contains request handling methods for create, update, delete and list of Todos.
package net.guides.springboot.todomanagement.controller;
import java.text.SimpleDateFormat;
import javax.validation.Valid;
import org.springframework.beans.propertyeditors.CustomDateEditor;
import
org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import net.guides.springboot.todomanagement.service.ITodoService;
@Controller
public class TodoController {
@Autowired
private ITodoService todoService;
@InitBinder
public void initBinder(WebDataBinder binder) {
// Date - dd/MM/yyyy
SimpleDateFormat dateFormat = new
SimpleDateFormat("dd/MM/yyyy");
binder.registerCustomEditor(Date.class, new
CustomDateEditor(dateFormat, false));
}
@RequestMapping(value = "/list-todos", method =

RequestMethod.GET)
public String showTodos(ModelMap model) {
String name = getLoggedInUserName(model);
model.put("todos", todoService.getTodosByUser(name));
// model.put("todos", service.retrieveTodos(name));
return "list-todos";
}
private String getLoggedInUserName(ModelMap model) {

Object principal =
SecurityContextHolder.getContext().getAuthentication().getPrincipal()
;
if (principal instanceof UserDetails) {

return ((UserDetails) principal).getUsername();
}
return principal.toString();
}
@RequestMapping(value = "/add-todo", method = RequestMethod.GET)

public String showAddTodoPage(ModelMap model) {
model.addAttribute("todo", new Todo());
return "todo";
}
@RequestMapping(value = "/delete-todo", method =

RequestMethod.GET)
public String deleteTodo(@RequestParam long id) {
todoService.deleteTodo(id);
// service.deleteTodo(id);
return "redirect:/list-todos";
}
@RequestMapping(value = "/update-todo", method =

RequestMethod.GET)
public String showUpdateTodoPage(@RequestParam long id, ModelMap
model) {
Todo todo = todoService.getTodoById(id).get();
model.put("todo", todo);
return "todo";
}
@RequestMapping(value = "/update-todo", method =

RequestMethod.POST)
public String updateTodo(ModelMap model, @Valid Todo todo,
BindingResult result) {
if (result.hasErrors()) {
return "todo";
}
todo.setUserName(getLoggedInUserName(model));
todoService.updateTodo(todo);
}
@RequestMapping(value = "/add-todo", method = RequestMethod.POST)

public String addTodo(ModelMap model, @Valid Todo todo,
BindingResult result) {
if (result.hasErrors()) {
return "todo";
}
todo.setUserName(getLoggedInUserName(model));
todoService.saveTodo(todo);
}
}
7. Controller Layer - WelcomeController.java
after a user successfully authenticated will navigates to welcome page and this request handled
by this WelcomeController Class.
import
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.ui.ModelMap;
@Controller
public class WelcomeController {
@RequestMapping(value = "/", method = RequestMethod.GET)

public String showWelcomePage(ModelMap model) {
model.put("name", getLoggedinUserName());
return "welcome";
}
private String getLoggedinUserName() {

Object principal = SecurityContextHolder.getContext()
.getAuthentication().getPrincipal();
if (principal instanceof UserDetails) {

return ((UserDetails) principal).getUsername();
}
return principal.toString();
}
8. Controller Layer - ErrorController.java
ErrorController used to map custom error page.

import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;
@Controller("error")
public class ErrorController {
@ExceptionHandler(Exception.class)
public ModelAndView handleException(HttpServletRequest request,
Exception ex) {
ModelAndView mv = new ModelAndView();
mv.addObject("exception", ex.getLocalizedMessage());
mv.addObject("url", request.getRequestURL());
mv.setViewName("error");
return mv;
}
9. Controller Layer - LogoutController.java
This Class handles, after logout successfully then navigate to a home page with a proper
message.
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.security.core.Authentication;
import
import
org.springframework.security.web.authentication.logout.SecurityContex
tLogoutHandler;
@Controller
public class LogoutController {
@RequestMapping(value = "/logout", method = RequestMethod.GET)

public String logout(HttpServletRequest request,
HttpServletResponse response) {
Authentication authentication =
SecurityContextHolder.getContext()
.getAuthentication();
if (authentication != null) {
new SecurityContextLogoutHandler().logout(request,
response,
authentication);
}
return "redirect:/";
}
}
10.Service Layer - ITodoService.java
Let's explore all the methods required to process Todo features in this interface.
package net.guides.springboot.todomanagement.service;
import java.util.Optional;
public interface ITodoService {
List < Todo > getTodosByUser(String user);
Optional < Todo > getTodoById(long id);
void updateTodo(Todo todo);
void addTodo(String name, String desc, Date targetDate, boolean

isDone);
void deleteTodo(long id);
void saveTodo(Todo todo);

}
11.Service Layer - TodoService.java
package net.guides.springboot.todomanagement.service;
import java.util.Optional;
import org.springframework.stereotype.Service;
import net.guides.springboot.todomanagement.repository.TodoRepository;
@Service
public class TodoService implements ITodoService {
@Autowired
private TodoRepository todoRepository;
@Override
public List < Todo > getTodosByUser(String user) {
return todoRepository.findByUserName(user);
}
@Override
public Optional < Todo > getTodoById(long id) {
return todoRepository.findById(id);
}
@Override
public void updateTodo(Todo todo) {
todoRepository.save(todo);
}
@Override
public void addTodo(String name, String desc, Date targetDate, boolean
isDone) {
todoRepository.save(new Todo(name, desc, targetDate, isDone));
}
@Override
public void deleteTodo(long id) {
Optional < Todo > todo = todoRepository.findById(id);
if (todo.isPresent()) {
todoRepository.delete(todo.get());
}
}
@Override
public void saveTodo(Todo todo) {
todoRepository.save(todo);
}
}
12. Configuring MySQL Database and JSP View Resolver
Configure application.properties to connect to your MySQL database. Let's open an

application.properties file and add following database configuration to it.
## Spring view resolver set up
spring.mvc.view.prefix=/WEB-INF/jsp/
spring.mvc.view.suffix=.jsp
## Spring DATASOURCE (DataSourceAutoConfiguration & DataSourceProperties)

spring.datasource.url = jdbc:mysql://localhost:3306/users_database?useSSL=false
spring.datasource.username = root
spring.datasource.password = root
## Hibernate Properties
# The SQL dialect makes Hibernate generate better SQL for the chosen database
spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.MySQL5InnoDBDialect
# Hibernate ddl auto (create, create-drop, validate, update)

spring.jpa.hibernate.ddl-auto = update
13. Common JSP page fragments - footer.jspf, header.jspf and navigation.jspf
footer.jspf View
<script src="webjars/jquery/1.9.1/jquery.min.js"></script>
<script src="webjars/bootstrap/3.3.6/js/bootstrap.min.js"></script>
<script src="webjars/bootstrap-datepicker/1.0.1/js/bootstrap-
datepicker.js"></script>
<script>
$('#targetDate').datepicker({
format: 'dd/mm/yyyy'
});
</script>
<div class="footer">
Fixed Footer
<h1>
<a href="http://www.javaguides.net/p/spring-boot-tutorial.html">
Spring Boot Tutorial</a>
</h1>
</div>
</body>
</html>
header.jspf
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt"%>
<%@taglib uri="http://www.springframework.org/tags/form" prefix="form"%>
<html>
<head>
<title>Todo Management</title>
<link href="webjars/bootstrap/3.3.6/css/bootstrap.min.css"
rel="stylesheet">
<style>
.footer {
position: fixed;
left: 0;
bottom: 0;
width: 100%;
background-color: black;
color: white;
height: 100px;
text-align: center;
}
</style>
</head>
<body>
navigation.jspf View
<nav role="navigation" class="navbar navbar-default">

<div class="">
<a href="http://www.javaguides.net" class="navbar-brand">Java
Guides</a>
</div>
<div class="navbar-collapse">
<ul class="nav navbar-nav">
<li class="active"><a href="/">Home</a></li>
<li><a href="/list-todos">Todos</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li><a href="/logout">Logout</a></li>
</ul>
</div>
</nav>
Now, we will include above page fragments into upcoming JSP pages.
Welcome Page View
<%@ include file="common/header.jspf"%>

<%@ include file="common/navigation.jspf"%>
<div class="container">
<div class="panel panel-primary">

<div class="panel-heading">Home Page</div>
<div class="panel-body">
Welcome ${name}!! <a href="/list-todos">Click here</a> to manage
your
todo's.
</div>
</div>
</div>
<%@ include file="common/footer.jspf"%>
Todo Page View

<div class="row">
<div class="col-md-6 col-md-offset-3 ">
<div class="panel-heading">Add TODO</div>
< form:form method="post" modelAttribute="todo">
<form:hidden path="id" />
<fieldset class="form-group">
<form: label path="description">Description</form:label>
<form:input path="description" type="text" class="form-
control"
required="required" />
<form: errors path="description" cssClass="text-warning" />
</fieldset>
<fieldset class="form-group">
<form: label path="targetDate">Target Date</form:label>
<form:input path="targetDate" type="text" class="form-control"
required="required" />
<form: errors path="targetDate" cssClass="text-warning" />
</fieldset>
<button type="submit" class="btn btn-success">Save</button>

</form:form >
</div>
</div>
</div>
</div>
</div>
List Todo Page View
<div class="c<div>
<a type="button" class="btn btn-primary btn-md" href="/add-
todo">Add Todo</a>
</div>
<br>
<div class="panel-heading">
<h3>List of TODO's</h3>
</div>
<table class="table table-striped">
<thead>
<tr>
<th width="40%">Description</th>
<th width="40%">Target Date</th>
<th width="20%"></th>
</tr>
</thead>
<tbody>
<c:forEach items="${todos}" var="todo">
<tr>
<td>${todo.description}</td>
<td><fmt:formatDate value="${todo.targetDate}"
pattern="dd/MM/yyyy" /></td>
<td><a type="button" class="btn btn-success"
href="/update-todo?id=${todo.id}">Update</a>
<a type="button" class="btn btn-warning"
href="/delete-todo?id=${todo.id}">Delete</a></td>
</tr>
</c:forEach>
</tbody>
</table>
</div>
</div>
</div>
<%@ include file="common/footer.jspf"%>ontainer">
Simple Error Page View

An exception occurred! Please contact Support!
</div>
14.Running the Application
We have successfully developed the Mini Todo Management web application. Now it's time to
deploy our application in a servlet container(embedded tomcat). Two ways we can start the
standalone Spring boot application.
1. From the root directory of the application and type the following command to run it -
$ mvn spring-boot:run
2. From your IDE, run the TodoManagementSpringBoot2Application.main() method as a

standalone Java class that will start the embedded Tomcat server on port 8080 and point
the browser to http://localhost:8080/.
15. Demo
1. Login Page
URL : http://localhost:8080/login
Username: admin
Password: admin
This is simple Spring Security provided login page. You can also create a custom login page.
2. Home Page
After successfully user logged in navigate to a home page.
3. List Todos
URL: http://localhost:8080/list-todos
4. Create Todo
URL: http://localhost:8080/add-todo
5. Update Todo
6. Logout Page
URL: http://localhost:8080/login?logout
I am done with developing mini Todo Management Spring MVC web application.

Lab11 - Mini Todo Management Project Using Spring Boot + Spring MVC + Spring Security + JSP + Hibernate + MySQL

Загружено:

Сведения о документе

Исходное описание:

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Lab11 - Mini Todo Management Project Using Spring Boot + Spring MVC + Spring Security + JSP + Hibernate + MySQL

Загружено:

Авторское право:

Доступные форматы

Lab 11 : Mini Todo Management Project using Spring Boot +

Spring MVC + Spring Security + JSP + Hibernate + MySQL

 Finish Todo feature

 Role-based spring security

 Spring Boot - 2.0.4.RELEASE

1. Creating and Importing a Project

 Generate: Maven Project

Following is the packing structure for your reference –

3. Create the JPA Entity - Todo.java

private String userName;

private Date targetDate;

public Todo(String user, String desc, Date targetDate, boolean

public long getId() {

public void setId(long id) {

public String getUserName() {

public String getDescription() {

public void setDescription(String description) {

public Date getTargetDate() {

public void setTargetDate(Date targetDate) {

4. Spring Data JPA Repository Interface - TodoRepository.java

public interface TodoRepository extends JpaRepository < Todo, Long >

5. Spring Security Configuration - SecurityConfiguration.java

6. Controller Layer - TodoController.java

@RequestMapping(value = "/list-todos", method =

private String getLoggedInUserName(ModelMap model) {

if (principal instanceof UserDetails) {

@RequestMapping(value = "/add-todo", method = RequestMethod.GET)

@RequestMapping(value = "/delete-todo", method =

@RequestMapping(value = "/update-todo", method =

@RequestMapping(value = "/update-todo", method =

@RequestMapping(value = "/add-todo", method = RequestMethod.POST)

7. Controller Layer - WelcomeController.java

@RequestMapping(value = "/", method = RequestMethod.GET)

private String getLoggedinUserName() {

if (principal instanceof UserDetails) {

8. Controller Layer - ErrorController.java

ErrorController used to map custom error page.

9. Controller Layer - LogoutController.java

@RequestMapping(value = "/logout", method = RequestMethod.GET)

10.Service Layer - ITodoService.java

public interface ITodoService {

List < Todo > getTodosByUser(String user);

Optional < Todo > getTodoById(long id);

void updateTodo(Todo todo);

void addTodo(String name, String desc, Date targetDate, boolean

void deleteTodo(long id);

void saveTodo(Todo todo);

11.Service Layer - TodoService.java

12. Configuring MySQL Database and JSP View Resolver

Configure application.properties to connect to your MySQL database. Let's open an

## Spring DATASOURCE (DataSourceAutoConfiguration & DataSourceProperties)

# Hibernate ddl auto (create, create-drop, validate, update)

13. Common JSP page fragments - footer.jspf, header.jspf and navigation.jspf

<nav role="navigation" class="navbar navbar-default">

Welcome Page View

<%@ include file="common/header.jspf"%>

<div class="panel panel-primary">

Todo Page View

<%@ include file="common/header.jspf"%>

<button type="submit" class="btn btn-success">Save</button>

List Todo Page View

Simple Error Page View