Spring Boot 中集成 Spring Security

2024-09-05 09:58
文章标签 java spring boot 集成 security

本文主要是介绍Spring Boot 中集成 Spring Security,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Spring Boot 集成 Spring Security的简单应用,从数据库读取数据校验用户,页面使用Thymeleaf模板


项目地址 https://github.com/helloworlde/SpringSecurity

演示 http://project.hellowood.com.cn/Security/

创建 Spring Boot 应用

添加依赖

    compile('org.springframework.boot:spring-boot-starter-security')compile('org.springframework.boot:spring-boot-starter-web')compile('org.mybatis.spring.boot:mybatis-spring-boot-starter:1.3.0')compile('org.springframework.boot:spring-boot-starter-thymeleaf')runtime('mysql:mysql-connector-java')runtime('org.springframework.boot:spring-boot-starter-tomcat')testCompile('org.springframework.boot:spring-boot-starter-test')testCompile('org.springframework.security:spring-security-test')    

创建用户表并插入数据

    CREATE TABLE user (id       INT                  AUTO_INCREMENT PRIMARY KEY,username VARCHAR(45) NOT NULL,password VARCHAR(45) NOT NULL,enabled  INT         NOT NULL DEFAULT 1);INSERT INTO user (username, password, enabled) VALUES ('username', 'password', TRUE);

添加配置信息

    spring.datasource.url=jdbc:mysql://localhost:3306/security?useSSL=falsespring.datasource.username=securityspring.datasource.password=securityspring.datasource.driver-class-name=com.mysql.jdbc.Drivermybatis.type-aliases-package=cn.com.hellowood.springsecurity.mappermybatis.mapper-locations=mappers/**Mapper.xml

添加 Security 配置文件

import cn.com.hellowood.springsecurity.security.CustomAuthenticationProvider;import org.springframework.beans.factory.annotation.Autowired;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.EnableWebSecurity;import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;@EnableWebSecuritypublic class SecurityConfig extends WebSecurityConfigurerAdapter {@Autowiredprivate CustomAuthenticationProvider customAuthenticationProvider;@Overrideprotected void configure(HttpSecurity http) throws Exception {// 所有请求均可访问http.authorizeRequests().antMatchers("/", "/login", "/login-error", "/css/**", "/index").permitAll();// 其余所有请求均需要权限http.authorizeRequests().anyRequest().authenticated();// 配置登录页面的表单 action 必须是 '/login', 用户名和密码的参数名必须是 'username' 和 'password',// 登录失败的 url 是 '/login-error'http.formLogin().loginPage("/login").loginProcessingUrl("/login").usernameParameter("username").passwordParameter("password").failureUrl("/login-error");}/*** Configure global.** @param auth the auth* @throws Exception the exception*/@Autowiredpublic void configureGlobal(AuthenticationManagerBuilder auth) {// 使用自定义的 Authentication Providerauth.authenticationProvider(customAuthenticationProvider);}}

添加自定义的 Authentication Provider 类

    import cn.com.hellowood.springsecurity.model.UserModel;import cn.com.hellowood.springsecurity.service.UserService;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.security.authentication.AccountExpiredException;import org.springframework.security.authentication.AuthenticationProvider;import org.springframework.security.authentication.BadCredentialsException;import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;import org.springframework.security.core.Authentication;import org.springframework.security.core.AuthenticationException;import org.springframework.security.core.GrantedAuthority;import org.springframework.stereotype.Component;import javax.servlet.http.HttpSession;import java.util.ArrayList;import java.util.List;@Componentpublic class CustomAuthenticationProvider implements AuthenticationProvider {private final Logger logger = LoggerFactory.getLogger(getClass());@Autowiredprivate HttpSession session;@Autowiredprivate UserService userService;/*** Validate user info is correct form database** @param authentication* @return* @throws AuthenticationException*/@Overridepublic Authentication authenticate(Authentication authentication) throws AuthenticationException {String username = authentication.getName();String password = authentication.getCredentials().toString();List<GrantedAuthority> grantedAuthorities = new ArrayList<>();// 检查用户名密码是否正确UserModel user = userService.loadUserByUsernameAndPassword(username, password);if (user == null) {logger.error("{} login failed, username or password is wrong", username);throw new BadCredentialsException("Username or password is not correct");} else if (!user.getEnabled()) {throw new AccountExpiredException("Account had expired");}// 用户信息有效时将其放入 session 中session.setAttribute("user", user);Authentication auth = new UsernamePasswordAuthenticationToken(username, password, grantedAuthorities);return auth;}@Overridepublic boolean supports(Class<?> authentication) {return authentication.equals(UsernamePasswordAuthenticationToken.class);}}

添加校验用户信息所需要的类

  • 添加 UserModel.java
public class UserModel {private Integer id;private String username;private String password;private Boolean enabled;/*** Instantiates a new User model.*/public UserModel() {}/*** Instantiates a new User model.** @param id       the id* @param username the username* @param password the password* @param enabled  the enabled*/public UserModel(Integer id, String username, String password, Boolean enabled) {this.id = id;this.username = username;this.password = password;this.enabled = enabled;}/*** Gets id.** @return the id*/public Integer getId() {return id;}/*** Sets id.** @param id the id*/public void setId(Integer id) {this.id = id;}/*** Gets username.** @return the username*/public String getUsername() {return username;}/*** Sets username.** @param username the username*/public void setUsername(String username) {this.username = username;}/*** Gets password.** @return the password*/public String getPassword() {return password;}/*** Sets password.** @param password the password*/public void setPassword(String password) {this.password = password;}/*** Gets enabled.** @return the enabled*/public Boolean getEnabled() {return enabled;}/*** Sets enabled.** @param enabled the enabled*/public void setEnabled(Boolean enabled) {this.enabled = enabled;}@Overridepublic String toString() {return "UserModel{" +"id=" + id +", username='" + username + '\'' +", password='" + password + '\'' +", enabled=" + enabled +'}';}}
  • 添加 UserService.java
import cn.com.hellowood.springsecurity.mapper.UserMapper;import cn.com.hellowood.springsecurity.model.UserModel;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Service;@Service("userService")public class UserService {@Autowiredprivate UserMapper userMapper;/*** Load user by username and password user model.** @param username the username* @param password the password* @return the user model*/public UserModel loadUserByUsernameAndPassword(String username, String password) {return userMapper.getUserByUsernameAndPassword(username, password);}}
  • 添加 UserMapper.java
    import cn.com.hellowood.springsecurity.model.UserModel;import org.apache.ibatis.annotations.Mapper;import org.apache.ibatis.annotations.Param;@Mapperpublic interface UserMapper {/*** Gets user by username and password.** @param username the username* @param password the password* @return the user by username and password*/UserModel getUserByUsernameAndPassword(@Param("username") String username,@Param("password") String password);}
  • 添加 UserMapper.xml
    <?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" ><mapper namespace="cn.com.hellowood.springsecurity.mapper.UserMapper"><resultMap id="baseResultMap" type="cn.com.hellowood.springsecurity.model.UserModel"><id column="id" property="id" javaType="java.lang.Integer" jdbcType="INTEGER"></id><result column="username" property="username" javaType="java.lang.String" jdbcType="VARCHAR"></result><result column="password" property="password" javaType="java.lang.String" jdbcType="VARCHAR"></result><result column="enabled" property="enabled" javaType="java.lang.Boolean" jdbcType="INTEGER"></result></resultMap><select id="getUserByUsernameAndPassword" resultType="cn.com.hellowood.springsecurity.model.UserModel">SELECTid,username,password,enabledFROM userWHERE username = #{username, jdbcType=VARCHAR}AND password = #{password, jdbcType=VARCHAR}</select></mapper>

添加页面

  • index.html
    <!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org"><head><title>Spring Security</title><meta charset="utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"/><link rel="stylesheet" href="/css/main.css" th:href="@{/css/main.css}"/><link rel="stylesheet" href="/css/bootstrap.min.css" th:href="@{/css/bootstrap.min.css}"/></head><body><div class="container"><form action="#" class="form-signin"><h2 class="form-signin-heading">Hello Spring Security</h2><h5 class="form-signin-heading content-adjust">Anyone can access this page</h5><div th:if="${session.user} != null"><h5 class="form-signin-heading content-adjust">Your username is <span th:text="${session.user.username}"></span></h5><a href="/user/index" th:href="@{/user/index}" class="btn btn-success btn-block">To Security page</a></div><div th:if="${session.user} == null"><a href="/index" th:href="@{/login}" class="btn btn-primary btn-block">To Login page</a></div></form><div th:fragment="logout" class="logout" th:if="${session.user} != null"><form action="#" th:action="@{/logout}" method="post" class="form-signin"><button class="btn btn-warning btn-block" type="submit">Log out</button></form></div></div></body></html>
  • login.html
    <!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org"><head><title>Login page</title><meta charset="utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"/><link rel="stylesheet" href="/css/main.css" th:href="@{/css/main.css}"/><link rel="stylesheet" href="/css/bootstrap.min.css" th:href="@{/css/bootstrap.min.css}"/></head><body><div class="container"><form th:action="@{/login}" method="post" class="form-signin"><h2 class="form-signin-heading">Please sign in</h2><div><label for="username" class="sr-only">Username</label><input type="text" id="username" name="username"th:class="${loginError} ? 'form-control is-invalid' : 'form-control'" placeholder="Username"required="required"autofocus="autofocus"/><div class="invalid-feedback" th:if="${loginError}">Wrong username or password</div></div><div><label for="password" class="sr-only">Password</label><input type="password" id="password" name="password" class="form-control" placeholder="Password"required="required"/></div><button class="btn btn-success btn-block" type="submit">Sign in</button><a href="/index" th:href="@{/index}" class="btn btn-primary btn-block">Back to Home page</a></form></div></body></html>
  • user/index.html
    <!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org"><head><title>Spring Security</title><meta charset="utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"/><link rel="stylesheet" href="/css/main.css" th:href="@{/css/main.css}"/><link rel="stylesheet" href="/css/bootstrap.min.css" th:href="@{/css/bootstrap.min.css}"/></head><body><div class="container"><form action="#" class="form-signin"><h2 class="form-signin-heading">Hello Spring Security</h2><h5 class="form-signin-heading content-adjust">Only logged in user can access this page</h5><div th:if="${session.user} != null"><h5 class="form-signin-heading content-adjust">Logged user is <span th:text="${session.user.username}"></span></h5><a href="/index" th:href="@{/index}" class="btn btn-primary btn-block">Back to Home page</a></div></form><div th:substituteby="index::logout"></div></div></body></html>

添加 Controller

    import org.springframework.stereotype.Controller;import org.springframework.ui.Model;import org.springframework.web.bind.annotation.RequestMapping;@Controllerpublic class MainController {/*** Root page.** @return the index page url*/@RequestMapping("/")public String root() {return "redirect:/index";}/*** Index page.** @return the index page url*/@RequestMapping("/index")public String index() {return "index";}/*** User index page.** @return the user index page url*/@RequestMapping("/user/index")public String userIndex() {return "user/index";}/*** Login page.** @return the login page url*/@RequestMapping("/login")public String login() {return "login";}/*** Login error page.** @param model the model* @return the login error page url*/@RequestMapping("/login-error")public String loginError(Model model) {model.addAttribute("loginError", true);return "login";}}

启动应用,访问http://localhost:8080/user/index,此时没有登录,会被拦截并重定向到登录页面http://localhost:8080/login,输入用户名 username 和密码 password,登录成功后再次访问http://localhost:8080/user/index,此时该 url 可以正常访问,当输入错误的用户名或密码时会提示错误信息,说明 Spring Security 配置正确

这篇关于Spring Boot 中集成 Spring Security的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1138640

相关文章

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的

Java controller接口出入参时间序列化转换操作方法(两种)

《Javacontroller接口出入参时间序列化转换操作方法(两种)》:本文主要介绍Javacontroller接口出入参时间序列化转换操作方法,本文给大家列举两种简单方法,感兴趣的朋友一起看... 目录方式一、使用注解方式二、统一配置场景:在controller编写的接口,在前后端交互过程中一般都会涉及

Java中的StringBuilder之如何高效构建字符串

《Java中的StringBuilder之如何高效构建字符串》本文将深入浅出地介绍StringBuilder的使用方法、性能优势以及相关字符串处理技术,结合代码示例帮助读者更好地理解和应用,希望对大家... 目录关键点什么是 StringBuilder?为什么需要 StringBuilder?如何使用 St

使用Java将各种数据写入Excel表格的操作示例

《使用Java将各种数据写入Excel表格的操作示例》在数据处理与管理领域,Excel凭借其强大的功能和广泛的应用,成为了数据存储与展示的重要工具,在Java开发过程中,常常需要将不同类型的数据,本文... 目录前言安装免费Java库1. 写入文本、或数值到 Excel单元格2. 写入数组到 Excel表格

Java并发编程之如何优雅关闭钩子Shutdown Hook

《Java并发编程之如何优雅关闭钩子ShutdownHook》这篇文章主要为大家详细介绍了Java如何实现优雅关闭钩子ShutdownHook,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起... 目录关闭钩子简介关闭钩子应用场景数据库连接实战演示使用关闭钩子的注意事项开源框架中的关闭钩子机制1.

Maven中引入 springboot 相关依赖的方式(最新推荐)

《Maven中引入springboot相关依赖的方式(最新推荐)》:本文主要介绍Maven中引入springboot相关依赖的方式(最新推荐),本文给大家介绍的非常详细,对大家的学习或工作具有... 目录Maven中引入 springboot 相关依赖的方式1. 不使用版本管理(不推荐)2、使用版本管理(推

Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

《Java中的@SneakyThrows注解使用方法(简化异常处理的利与弊)》为了简化异常处理,Lombok提供了一个强大的注解@SneakyThrows,本文将详细介绍@SneakyThro... 目录1. @SneakyThrows 简介 1.1 什么是 Lombok?2. @SneakyThrows

在 Spring Boot 中实现异常处理最佳实践

《在SpringBoot中实现异常处理最佳实践》本文介绍如何在SpringBoot中实现异常处理,涵盖核心概念、实现方法、与先前查询的集成、性能分析、常见问题和最佳实践,感兴趣的朋友一起看看吧... 目录一、Spring Boot 异常处理的背景与核心概念1.1 为什么需要异常处理?1.2 Spring B

如何在 Spring Boot 中实现 FreeMarker 模板

《如何在SpringBoot中实现FreeMarker模板》FreeMarker是一种功能强大、轻量级的模板引擎,用于在Java应用中生成动态文本输出(如HTML、XML、邮件内容等),本文... 目录什么是 FreeMarker 模板?在 Spring Boot 中实现 FreeMarker 模板1. 环

SpringMVC 通过ajax 前后端数据交互的实现方法

《SpringMVC通过ajax前后端数据交互的实现方法》:本文主要介绍SpringMVC通过ajax前后端数据交互的实现方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价... 在前端的开发过程中,经常在html页面通过AJAX进行前后端数据的交互,SpringMVC的controll