在本文中,我们将学习如何使用弹簧启动,弹簧MVC,弹簧安全性,JSP,JPA和MySQL作为数据库来开发弹簧MVC待办事项管理Web应用程序。
这个迷你项目主要是为初学者学习如何使用弹簧启动一步一步地开发弹簧MVC Web应用程序。
以下功能在此迷你待办事项管理项目中实现:
- 创建待办事项
- 更新待办事项
- 删除待办事项
- 列出待办事项
- 通过ID获取待办事项。
- 简单的弹簧安全
- 用于管理客户端依赖项(CSS 和 JS)的 Webjars。
- JSP 作为视图和公共页眉、页脚和导航栏。
- 自定义错误页映射
您可以将以下功能实现到此待办事项管理项目中(这是一个练习):
- 完成待办事项功能: 添加完成按钮并针对数据库中的每条记录保存状态。
- 伐木:
请参阅下面的文章,以在此待办事项管理项目中有效地实现日志记录 弹簧启动 2 日志记录 SLF4j 日志和 LOG4j2 示例
- 基于角色的弹簧安全性:
请参阅下面的文章,在此待办事项管理项目中有效地实现基于角色的弹簧安全性 弹簧启动 + 弹簧 MVC + 基于角色的弹簧安全性 + JPA + 百叶 + MySQL 教程
- 异常处理:
请参阅以下文章,在此 Todo 管理项目中有效地实现异常处理 REST API 的弹簧启动 2 异常处理
- 验证:
请参阅以下文章,在此待办事项管理项目中有效地实现验证 春季启动 CRUD REST API 验证示例
- 审计:
请参阅以下文章,在此待办事项管理项目中有效实施审计 使用弹簧启动 2 和 MySQL 示例进行春季数据 JPA 审计
视频教程
本教程在下面的优酷视频中进行了解释。订阅我的YouTube频道,以了解有关Java指南 - YouTube频道春季启动的更多信息。
我们将构建什么
我们将使用弹簧启动,弹簧MVC,弹簧安全,JSP,JPA和MySQL作为数据库,逐步开发弹簧MVC待办事项管理Web应用程序。
使用的工具和技术
- 弹簧启动 - 2.0.4.发布
- JDK - 1.8 或更高版本
- 春季框架 - 5.0.8 发布
- 休眠 - 5.2.17.最终版
- 梅文 - 3.2+
- 春季数据JPA - 2.0.10发布
- IDE - 日食或弹簧工具套件 (STS)
- 神秘记忆障碍 - 5.1.47
- 春季安全 - 5.0.7 发布
- .JSP
创建和导入项目
有许多方法可以创建弹簧启动应用程序。最简单的方法是在 http://start.spring.io/ 使用弹簧初始化器,这是一个在线弹簧启动应用程序生成器。
看上图,我们指定了以下细节:
- 生成:梅文项目
- Java 版本:1.8(默认)
- 弹簧靴:2.0.4
- 组: 网游
- 工件:待办事项管理弹簧启动
- 名称:待办事项管理弹簧启动
- 描述: 待办事项管理弹簧启动
- 套餐名称 : 网游指南
- 包装:罐子(这是默认值)
- 依赖项:Web、JPA、MySQL、开发工具、安全性
输入所有详细信息后,单击“生成项目”按钮将生成一个弹簧启动项目并下载它。接下来,解压缩下载的 zip 文件并将其导入到您喜欢的 IDE 中。
包装结构
以下是包装结构供您参考 -
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 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.7.4</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.apache.tomcat.embed</groupId>
<artifactId>tomcat-embed-jasper</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</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-security</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<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>
<!-- https://mvnrepository.com/artifact/javax.validation/validation-api -->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
<dependency>
<groupId>jstl</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>bootstrap</artifactId>
<version>3.3.6</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>bootstrap-datepicker</artifactId>
<version>1.0.1</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>jquery</artifactId>
<version>1.9.1</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
请注意,我们已经使用春季数据JPA启动器与MySQL数据库进行通信。
创建 JPA 实体 - 待办事项.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.
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);
}
Spring 安全配置 - 安全配置.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.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
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();
}
}
此类扩展了 Web 安全配置器适配器,并重写了它的几个方法来设置 Web 安全配置的某些细节。
配置(Http 安全性)方法定义了哪些 URL 路径应该受到保护,哪些不应该受到保护。具体来说,“/”和“/登录”路径配置为不需要任何身份验证。所有其他路径都必须经过身份验证。
至于用户详细信息服务()方法,它设置了一个具有单个用户的内存中用户存储。该用户将获得“admin”的用户名,“admin”的密码和“ADMIN”的角色。
控制器层 - 待办事项控制器.java
此类包含用于创建、更新、删除和列出 Todos 的请求处理方法。
package net.guides.springboot.todomanagement.controller;
import java.text.SimpleDateFormat;
import java.util.Date;
import javax.validation.Valid;
import org.springframework.beans.factory.annotation.Autowired;
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.model.Todo;
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);
return "redirect:/list-todos";
}
@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);
return "redirect:/list-todos";
}
}
控制器层 - 欢迎控制器.java
用户成功通过身份验证后,将导航到欢迎页面,此请求由此欢迎控制器类处理。
package net.guides.springboot.todomanagement.controller;
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.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@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();
}
}
控制器层 - 错误控制器.java
用于映射自定义错误页的错误控制器。
package net.guides.springboot.todomanagement.controller;
import javax.servlet.http.HttpServletRequest;
import org.springframework.stereotype.Controller;
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;
}
}
控制器层 - 注销控制器.java
此类在成功注销后进行处理,然后导航到带有正确消息的主页。
package net.guides.springboot.todomanagement.controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.web.authentication.logout.SecurityContextLogoutHandler;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@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:/";
}
}
服务层 - ITodoService.java
让我们探讨在此界面中处理 Todo 功能所需的所有方法。
package net.guides.springboot.todomanagement.service;
import java.util.Date;
import java.util.List;
import java.util.Optional;
import net.guides.springboot.todomanagement.model.Todo;
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);
}
服务层 - 待办事项服务.java
package net.guides.springboot.todomanagement.service;
import java.util.Date;
import java.util.List;
import java.util.Optional;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import net.guides.springboot.todomanagement.model.Todo;
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);
}
}
配置我的数据库和 JSP 视图解析程序
配置应用程序属性以连接到 MySQL 数据库。让我们打开一个应用程序 .properties 文件,并向其中添加以下数据库配置。
## 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
常见的 JSP 页面片段 - 页脚、页眉和导航
页脚.jspf 视图
<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>
现在,我们将上面的页面片段包含在即将推出的 JSP 页面中。
欢迎页面视图
<%@ 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"%>
待办事项页面视图
<%@ include file="common/header.jspf"%>
<%@ include file="common/navigation.jspf"%>
<div class="container">
<div class="row">
<div class="col-md-6 col-md-offset-3 ">
<div class="panel panel-primary">
<div class="panel-heading">Add TODO</div>
<div class="panel-body">
<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>
<%@ include file="common/footer.jspf"%>
列出待办事项页面视图
<%@ include file="common/header.jspf"%>
<%@ include file="common/navigation.jspf"%>
<div class="container">
<div>
<a type="button" class="btn btn-primary btn-md" href="/add-todo">Add Todo</a>
</div>
<br>
<div class="panel panel-primary">
<div class="panel-heading">
<h3>List of TODO's</h3>
</div>
<div class="panel-body">
<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"%>
简单错误页面视图
<%@ include file="common/header.jspf"%>
<%@ include file="common/navigation.jspf"%>
<div class="container">
An exception occurred! Please contact Support!
</div>
<%@ include file="common/footer.jspf"%>
运行应用程序
我们已经成功地开发了迷你待办事项管理Web应用程序。现在是时候将我们的应用程序部署在 servlet 容器(嵌入式 tomcat)中了。有两种方法可以启动独立的弹簧启动应用程序。
- 从应用程序的根目录中,键入以下命令以运行它 -
$ mvn spring-boot:run
- 在 IDE 中,将 TodoManagementSpringBoot2 应用程序.main() 方法作为一个独立的 Java 类运行,该类将在端口 8080 上启动嵌入式 Tomcat 服务器,并将浏览器指向 http://localhost:8080/。
演示
2. 主页
用户成功登录后,导航到主页。
3. 列出待办事项
6. 注销页面
我完成了迷你待办事项管理春季MVC Web应用程序的开发。
如果您对本文有任何建议或反馈,请发表评论,如果您需要我的任何帮助,请告诉我。
本文的源代码可在我的 Github 存储库上 找到 https://github.com/RameshMF/todo-management-spring-boot
GitHub - allwaysoft/todo-management-spring-boot: Mini Todo Management Project using Spring Boot Spring MVC Spring Security JSP MySQL