【系统权限管理】SpringSecurity实现动态权限菜单控制(【Springboot系列】Springboot入门到项目实战)

写在前面: 从2018年底开始学习SpringBoot,也用SpringBoot写过一些项目。现在想对学习Springboot的一些知识总结记录一下。如果你也在学习SpringBoot,可以关注我,一起学习,一起进步。

相关文章:

【Springboot系列】Springboot入门到项目实战


目录

系统权限管理

1、前言

2、案例技术栈

数据库设计

2、表关系

2、数据库表结构

新建项目

1、新建springboot项目

2、项目结构

编写代码

1、编写实体类

2、Security配置文件

3、动态权限菜单加载相关方法

4、首页菜单遍历

测试应用

1、对应效果展示

2、测试应用

3、案例代码下载


系统权限管理

1、前言

在实际开发中,开发任何一套系统,基本都少不了权限管理这一块。这些足以说明权限管理的重要性。其实SpringSecurity去年就学了,一直没有时间整理,用了一年多时间了,给我的印象一直都挺好,实用,安全性高(Security可以对密码进行加密)。而且这一块在实际开发中也的确很重要,所以这里整理了一套基于SpringSecurity的权限管理。案例代码下面有下载链接。

2、案例技术栈

如果对于SpringSecurity还不了解的话可以先了解一下SpringSecurity安全控件的学习,页面采用的是Bootstrap写的(页面就简单的写了一下,可以根据自己的需求更改),其实后端理解了,前台就是显示作用,大家可以自行更换前台页面显示框架,持久层使用的是Spring-Data-Jpa,Spring-Data-Jpa入门篇。并且对后端持久层和控制器进行了一下小封装,Java持久层和控制器的封装。页面使用的Thymeleaf模板,SpringBoot整合Thymeleaf模板

数据库设计

2、表关系

菜单(TbMenu)=====> 页面上需要显示的所有菜单

角色(SysRole)=====> 角色及角色对应的菜单

用户(SysUser)=====> 用户及用户对应的角色

用户和角色中间表(sys_user_role)====> 用户和角色中间表

2、数据库表结构

菜单表tb_menu

角色及菜单权限表sys_role,其中父节点parent 为null时为角色,不为null时为对应角色的菜单权限。

用户表sys_user。

用户和角色多对多关系,用户和角色中间表sys_user_role(有Spring-Data-Jpa自动生成)。

新建项目

1、新建springboot项目

新建springboot项目,在项目中添加SpringSecurity相关Maven依赖,pom.map文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <parent>
  6. <groupId>org.springframework.boot</groupId>
  7. <artifactId>spring-boot-starter-parent</artifactId>
  8. <version>2.2.2.RELEASE</version>
  9. <relativePath/> <!-- lookup parent from repository -->
  10. </parent>
  11. <groupId>com.mcy</groupId>
  12. <artifactId>springboot-security</artifactId>
  13. <version>0.0.1-SNAPSHOT</version>
  14. <name>springboot-security</name>
  15. <description>Demo project for Spring Boot</description>
  16. <properties>
  17. <java.version>1.8</java.version>
  18. </properties>
  19. <dependencies>
  20. <dependency>
  21. <groupId>org.springframework.boot</groupId>
  22. <artifactId>spring-boot-starter-data-jpa</artifactId>
  23. </dependency>
  24. <dependency>
  25. <groupId>org.springframework.boot</groupId>
  26. <artifactId>spring-boot-starter-security</artifactId>
  27. </dependency>
  28. <dependency>
  29. <groupId>org.springframework.boot</groupId>
  30. <artifactId>spring-boot-starter-thymeleaf</artifactId>
  31. </dependency>
  32. <dependency>
  33. <groupId>org.springframework.boot</groupId>
  34. <artifactId>spring-boot-starter-web</artifactId>
  35. </dependency>
  36. <dependency>
  37. <groupId>mysql</groupId>
  38. <artifactId>mysql-connector-java</artifactId>
  39. <scope>runtime</scope>
  40. </dependency>
  41. <dependency>
  42. <groupId>org.springframework.boot</groupId>
  43. <artifactId>spring-boot-starter-test</artifactId>
  44. <scope>test</scope>
  45. <exclusions>
  46. <exclusion>
  47. <groupId>org.junit.vintage</groupId>
  48. <artifactId>junit-vintage-engine</artifactId>
  49. </exclusion>
  50. </exclusions>
  51. </dependency>
  52. <dependency>
  53. <groupId>org.springframework.security</groupId>
  54. <artifactId>spring-security-test</artifactId>
  55. <scope>test</scope>
  56. </dependency>
  57. <dependency>
  58. <groupId>org.thymeleaf.extras</groupId>
  59. <artifactId>thymeleaf-extras-springsecurity5</artifactId>
  60. </dependency>
  61. <dependency>
  62. <groupId>org.springframework.boot</groupId>
  63. <artifactId>spring-boot-devtools</artifactId>
  64. <scope>runtime</scope>
  65. <optional>true</optional>
  66. </dependency>
  67. <dependency>
  68. <groupId>org.webjars.bower</groupId>
  69. <artifactId>bootstrap-select</artifactId>
  70. <version>2.0.0-beta1</version>
  71. </dependency>
  72. <dependency>
  73. <groupId>org.webjars</groupId>
  74. <artifactId>bootbox</artifactId>
  75. <version>4.4.0</version>
  76. </dependency>
  77. </dependencies>
  78. <build>
  79. <plugins>
  80. <plugin>
  81. <groupId>org.springframework.boot</groupId>
  82. <artifactId>spring-boot-maven-plugin</artifactId>
  83. </plugin>
  84. </plugins>
  85. </build>
  86. </project>

2、项目结构

编写代码

1、编写实体类

菜单表实体类TbMenu,Spring-Data-Jpa可以根据实体类去数据库新建或更新对应的表结构,详情可以访问Spring-Data-Jpa入门

  1. import com.fasterxml.jackson.annotation.JsonIgnore;
  2. import com.mcy.springbootsecurity.custom.BaseEntity;
  3. import org.springframework.data.annotation.CreatedBy;
  4. import javax.persistence.*;
  5. import java.util.ArrayList;
  6. import java.util.List;
  7. /**
  8. * 菜单表
  9. * @author
  10. *
  11. */
  12. @Entity
  13. public class TbMenu extends BaseEntity<Integer> {
  14. private String name;
  15. private String url;
  16. private Integer idx;
  17. @JsonIgnore
  18. private TbMenu parent;
  19. @JsonIgnore
  20. private List<TbMenu> children=new ArrayList<>();
  21. @Column(unique=true)
  22. public String getName() {
  23. return name;
  24. }
  25. public void setName(String name) {
  26. this.name = name;
  27. }
  28. public String getUrl() {
  29. return url;
  30. }
  31. public void setUrl(String url) {
  32. this.url = url;
  33. }
  34. public Integer getIdx() {
  35. return idx;
  36. }
  37. public void setIdx(Integer idx) {
  38. this.idx = idx;
  39. }
  40. @ManyToOne
  41. @CreatedBy
  42. public TbMenu getParent() {
  43. return parent;
  44. }
  45. public void setParent(TbMenu parent) {
  46. this.parent = parent;
  47. }
  48. @OneToMany(cascade=CascadeType.ALL,mappedBy="parent")
  49. @OrderBy(value="idx")
  50. public List<TbMenu> getChildren() {
  51. return children;
  52. }
  53. public void setChildren(List<TbMenu> children) {
  54. this.children = children;
  55. }
  56. public TbMenu(Integer id) {
  57. super(id);
  58. }
  59. public TbMenu(){
  60. super();
  61. }
  62. public TbMenu(String name, String url, Integer idx, TbMenu parent, List<TbMenu> children) {
  63. this.name = name;
  64. this.url = url;
  65. this.idx = idx;
  66. this.parent = parent;
  67. this.children = children;
  68. }
  69. public TbMenu(Integer integer, String name, String url, Integer idx, TbMenu parent, List<TbMenu> children) {
  70. super(integer);
  71. this.name = name;
  72. this.url = url;
  73. this.idx = idx;
  74. this.parent = parent;
  75. this.children = children;
  76. }
  77. @Transient
  78. public Integer getParentId() {
  79. return parent==null?null:parent.getId();
  80. }
  81. }

表新建好了,下面就是实现增删改查就可以了。实现效果如下。

新增和修改菜单。

对于Bootstrap的树形表格,可以移步到:BootStrap-bable-treegrid树形表格的使用

菜单管理实现了,下一步就是实现角色及角色对应的权限管理了。

角色及权限表SysRole,parent 为null时为角色,不为null时为权限。

  1. package com.mcy.springbootsecurity.entity;
  2. import com.fasterxml.jackson.annotation.JsonIgnore;
  3. import com.mcy.springbootsecurity.custom.BaseEntity;
  4. import org.springframework.data.annotation.CreatedBy;
  5. import javax.persistence.*;
  6. import java.util.ArrayList;
  7. import java.util.List;
  8. @Entity
  9. /***
  10. * 角色及角色对应的菜单权限
  11. * @author
  12. *parent 为null时为角色,不为null时为权限
  13. */
  14. public class SysRole extends BaseEntity<Integer> {
  15. private String name; //名称
  16. private String code; //代码
  17. @JsonIgnore
  18. private SysRole parent;
  19. private Integer idx; //排序
  20. @JsonIgnore
  21. private List<SysRole> children = new ArrayList<>();
  22. @Column(length=20)
  23. public String getName() {
  24. return name;
  25. }
  26. public void setName(String name) {
  27. this.name = name;
  28. }
  29. public String getCode() {
  30. return code;
  31. }
  32. public void setCode(String code) {
  33. this.code = code;
  34. }
  35. @ManyToOne
  36. @CreatedBy
  37. public SysRole getParent() {
  38. return parent;
  39. }
  40. public void setParent(SysRole parent) {
  41. this.parent = parent;
  42. }
  43. @OneToMany(cascade=CascadeType.ALL,mappedBy="parent")
  44. public List<SysRole> getChildren() {
  45. return children;
  46. }
  47. public void setChildren(List<SysRole> children) {
  48. this.children = children;
  49. }
  50. //获取父节点id
  51. @Transient
  52. public Integer getParentId() {
  53. return parent==null?null:parent.getId();
  54. }
  55. public Integer getIdx() {
  56. return idx;
  57. }
  58. public void setIdx(Integer idx) {
  59. this.idx = idx;
  60. }
  61. public SysRole(String name, String code, SysRole parent, Integer idx, List<SysRole> children) {
  62. this.name = name;
  63. this.code = code;
  64. this.parent = parent;
  65. this.idx = idx;
  66. this.children = children;
  67. }
  68. public SysRole(Integer id, String name, String code, SysRole parent, Integer idx, List<SysRole> children) {
  69. super(id);
  70. this.name = name;
  71. this.code = code;
  72. this.parent = parent;
  73. this.idx = idx;
  74. this.children = children;
  75. }
  76. public SysRole(Integer id) {
  77. super(id);
  78. }
  79. public SysRole(){}
  80. }

首先需要实现角色管理,之后在角色中添加对应的菜单权限。

实现效果(也可以和菜单管理一样,用树形表格展示,根据个人需求。这里用的是树形菜单展示的)。

给角色分配权限。

最后实现的就是用户管理了,只需要对添加的用户分配对应的角色就可以了,用户登录时,显示角色对应的权限。

用户表SysUser,继承的BaseEntity类中就一个ID字段。

  1. import com.fasterxml.jackson.annotation.JsonIgnore;
  2. import com.mcy.springbootsecurity.custom.BaseEntity;
  3. import javax.persistence.*;
  4. import java.util.ArrayList;
  5. import java.util.List;
  6. /**
  7. * 用户表
  8. */
  9. @Entity
  10. public class SysUser extends BaseEntity<Integer> {
  11. private String username; //账号
  12. private String password; //密码
  13. private String name; //姓名
  14. private String address; //地址
  15. @JsonIgnore
  16. private List<SysRole> roles=new ArrayList<>(); //角色
  17. @Column(length=20,unique=true)
  18. public String getUsername() {
  19. return username;
  20. }
  21. public void setUsername(String username) {
  22. this.username = username;
  23. }
  24. @Column(length=100)
  25. public String getPassword() {
  26. return password;
  27. }
  28. public void setPassword(String password) {
  29. this.password = password;
  30. }
  31. @Column(length=20)
  32. public String getName() {
  33. return name;
  34. }
  35. public void setName(String name) {
  36. this.name = name;
  37. }
  38. @ManyToMany(cascade=CascadeType.REFRESH,fetch=FetchType.EAGER)
  39. @JoinTable(name="sys_user_role",joinColumns=@JoinColumn(name="user_id"),inverseJoinColumns=@JoinColumn(name="role_id"))
  40. public List<SysRole> getRoles() {
  41. return roles;
  42. }
  43. public void setRoles(List<SysRole> roles) {
  44. this.roles = roles;
  45. }
  46. public String getAddress() {
  47. return address;
  48. }
  49. public void setAddress(String address) {
  50. this.address = address;
  51. }
  52. //角色名称
  53. @Transient
  54. public String getRoleNames() {
  55. String str="";
  56. for (SysRole role : getRoles()) {
  57. str+=role.getName()+",";
  58. }
  59. if(str.length()>0) {
  60. str=str.substring(0, str.length()-1);
  61. }
  62. return str;
  63. }
  64. //角色代码
  65. @Transient
  66. public String getRoleCodes() {
  67. String str="";
  68. for (SysRole role : getRoles()) {
  69. str+=role.getCode()+",";
  70. }
  71. if(str.indexOf(",")>0) {
  72. str=str.substring(0,str.length()-1);
  73. }
  74. return str;
  75. }
  76. }

用户管理就基本的数据表格,效果如图。

2、Security配置文件

Security相关配置文件,下面两个文件如果看不懂,可以访问SpringSecurity安全控件的学习中有详细讲解。

  1. package com.mcy.springbootsecurity.security;
  2. import com.mcy.springbootsecurity.service.SysUserService;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
  6. import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  7. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  8. import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
  9. @Configuration
  10. public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
  11. @Autowired
  12. private SysUserService userService;
  13. /**
  14. * 用户认证操作
  15. * @param auth
  16. * @throws Exception
  17. */
  18. @Override
  19. protected void configure(AuthenticationManagerBuilder auth) throws Exception {
  20. //添加用户,并给予权限
  21. auth.inMemoryAuthentication().withUser("aaa").password("{noop}1234").roles("DIY");
  22. //设置认证方式
  23. auth.userDetailsService(userService).passwordEncoder(new BCryptPasswordEncoder());
  24. }
  25. /**
  26. * 用户授权操作
  27. * @param http
  28. * @throws Exception
  29. */
  30. @Override
  31. protected void configure(HttpSecurity http) throws Exception {
  32. http.csrf().disable(); //安全器令牌
  33. http.formLogin()
  34. //登录请求被拦截
  35. .loginPage("/login").permitAll()
  36. //设置默认登录成功跳转页面
  37. .successForwardUrl("/main")
  38. .failureUrl("/login?error"); //登录失败的页面
  39. http.authorizeRequests().antMatchers("/static/**", "/assets/**").permitAll(); //文件下的所有都能访问
  40. http.authorizeRequests().antMatchers("/webjars/**").permitAll();
  41. http.logout().logoutUrl("/logout").permitAll(); //退出
  42. http.authorizeRequests().anyRequest().authenticated(); //除此之外的都必须通过请求验证才能访问
  43. }
  44. }

获取登录者相关信息,工具类。

  1. import com.mcy.springbootsecurity.entity.SysUser;
  2. import com.mcy.springbootsecurity.service.SysUserService;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.security.core.GrantedAuthority;
  5. import org.springframework.security.core.context.SecurityContextHolder;
  6. import org.springframework.security.core.userdetails.UserDetails;
  7. import org.springframework.stereotype.Component;
  8. import java.util.ArrayList;
  9. import java.util.List;
  10. //创建会话,获取当前登录对象
  11. @Component
  12. public class UserUtils {
  13. @Autowired
  14. private SysUserService userService;
  15. /**
  16. * 获取当前登录者的信息
  17. * @return 当前者信息
  18. */
  19. public SysUser getUser() {
  20. //获取当前用户的用户名
  21. String username = SecurityContextHolder.getContext().getAuthentication().getName();
  22. SysUser user = userService.findByUsername(username);
  23. return user;
  24. }
  25. /**
  26. * 判断此用户中是否包含roleName菜单权限
  27. * @param roleName
  28. * @return
  29. */
  30. public Boolean hasRole(String roleName) {
  31. //获取UserDetails类,
  32. UserDetails userDetails = (UserDetails) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
  33. List<String> roleCodes=new ArrayList<>();
  34. for (GrantedAuthority authority : userDetails.getAuthorities()) {
  35. //getAuthority()返回用户对应的菜单权限
  36. roleCodes.add(authority.getAuthority());
  37. }
  38. return roleCodes.contains(roleName);
  39. }
  40. }

3、动态权限菜单加载相关方法

用户表的SysUserService需要实现UserDetailsService接口,因为在SpringSecurity中配置的相关参数需要是UserDetailsService类的数据。重写UserDetailsService接口中的loadUserByUsername方法,通过该方法查询对应的用户,返回对象UserDetails是SpringSecurity的一个核心接口。其中定义了一些可以获取用户名,密码,权限等与认证相关信息的方法。

重写的loadUserByUsername方法。

  1. @Override
  2. public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
  3. //调用持久层接口findByUsername方法查询用户。
  4. SysUser user = userRepository.findByUsername(username);
  5. if(user == null){
  6. throw new UsernameNotFoundException("用户名不存在");
  7. }
  8. //创建List集合,用来保存用户菜单权限,GrantedAuthority对象代表赋予当前用户的权限
  9. List<GrantedAuthority> authorities = new ArrayList<>();
  10. //获得当前用户角色集合
  11. List<SysRole> roles = user.getRoles();
  12. List<SysRole> haveRoles=new ArrayList<>();
  13. for (SysRole role : roles) {
  14. haveRoles.add(role);
  15. List<SysRole> children = roleService.findByParent(role);
  16. children.removeAll(haveRoles);
  17. haveRoles.addAll(children);
  18. }
  19. for(SysRole role: haveRoles){
  20. //将关联对象role的name属性保存为用户的认证权限
  21. authorities.add(new SimpleGrantedAuthority(role.getName()));
  22. }
  23. //此处返回的是org.springframework.security.core.userdetails.User类,该类是SpringSecurity内部的实现
  24. //org.springframework.security.core.userdetails.User类实现了UserDetails接口
  25. return new User(user.getUsername(), user.getPassword(), authorities);
  26. }

所有功能实现了,最后就是根据角色去显示对应的菜单了。

在TbMenuService类中的findAuditMenu方法,查询当前用户所拥有的权限菜单。

  1. /**
  2. * 获取用户所拥有的权限对应的菜单项
  3. * @return
  4. */
  5. public List<TbMenu> findAuditMenu() {
  6. List<TbMenu> menus;
  7. //判断是否是后门用户
  8. if(userUtils.hasRole("ROLE_DIY")){
  9. //查询所有菜单,子菜单可以通过父级菜单的映射得到
  10. menus = menuRepository.findByParentIsNullOrderByIdx();
  11. }else{
  12. //获取此用户对应的菜单权限
  13. menus = auditMenu(menuRepository.findByParentIsNullOrderByIdx());
  14. }
  15. return menus;
  16. }
  17. //根据用户的菜单权限对菜单进行过滤
  18. private List<TbMenu> auditMenu(List<TbMenu> menus) {
  19. List<TbMenu> list = new ArrayList<>();
  20. for(TbMenu menu: menus){
  21. String name = menu.getName();
  22. //判断此用户是否有此菜单权限
  23. if(userUtils.hasRole(name)){
  24. list.add(menu);
  25. //递归判断子菜单
  26. if(menu.getChildren() != null && !menu.getChildren().isEmpty()) {
  27. menu.setChildren(auditMenu(menu.getChildren()));
  28. }
  29. }
  30. }
  31. return list;
  32. }

在UserUtils工具类中的hasRole方法,判断此用户中是否包含roleName菜单权限。

  1. public Boolean hasRole(String roleName) {
  2. //获取UserDetails类,
  3. UserDetails userDetails = (UserDetails) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
  4. List<String> roleCodes=new ArrayList<>();
  5. for (GrantedAuthority authority : userDetails.getAuthorities()) {
  6. //getAuthority()返回用户对应的菜单权限
  7. roleCodes.add(authority.getAuthority());
  8. }
  9. return roleCodes.contains(roleName);
  10. }

之后在控制器中返回用户对应的菜单权限,之后在前台页面遍历就可以了。

  1. @RequestMapping(value = "/main")
  2. public String main(ModelMap map){
  3. //加载菜单
  4. List<TbMenu> menus = menuService.findAuditMenu();
  5. map.put("menus", menus);
  6. if (menus.isEmpty()) {
  7. return "main/main";
  8. }
  9. return "main/main1";
  10. }

4、首页菜单遍历

首页菜单遍历,这里使用的是LayUI菜单,如果其他框架可以自行根据页面标签规律遍历,因为页面使用的是Thymeleaf模板,不是JSP,使用遍历菜单时不是采用的EL表达式,而是使用的Thymeleaf自带的标签表达式Thymeleaf模板的使用

  1. <div id="main">
  2. <div id="main_nav">
  3. <div class="panel-group" id="accordion" style="margin-bottom: 0;">
  4. <div th:each="menu, menuStat: ${menus}" th:if="${menu.children.size() != 0 && menu.children != null}" class="panel panel-default">
  5. <div class="panel-heading">
  6. <h4 class="panel-title">
  7. <p data-toggle="collapse" data-parent="#accordion" th:href="|#collapseOne${menuStat.index}|">
  8. <span th:text="${menu.name}">系统设置</span><span class="caret"></span>
  9. </p>
  10. </h4>
  11. </div>
  12. <div th:if="${menuStat.first}" th:id="|collapseOne${menuStat.index}|" class="panel-collapse collapse collapse in">
  13. <div class="panel-body">
  14. <p th:each="subMenu:${menu.children}" th:src="${subMenu.url}" th:text="${subMenu.name}">菜单管理</p>
  15. </div>
  16. </div>
  17. <div th:if="${!menuStat.first}" th:id="|collapseOne${menuStat.index}|" class="panel-collapse collapse collapse">
  18. <div class="panel-body">
  19. <p th:each="subMenu:${menu.children}" th:src="${subMenu.url}" th:text="${subMenu.name}">菜单管理</p>
  20. </div>
  21. </div>
  22. </div>
  23. </div>
  24. <div id="nav_p">
  25. <p th:each="menu:${menus}" th:if="${menu.children.size() == 0}" th:src="${menu.url}" th:text="${menu.name}">成绩管理</p>
  26. </div>
  27. </div>
  28. <div id="main_home">
  29. 首页内容
  30. </div>
  31. </div>

测试应用

1、对应效果展示

用户数据及对应的角色

管理员对应的菜单权限。

用户角色对应的菜单权限。

测试用户角色对应的菜单权限。

2、测试应用

用户名为admin1有管理员角色的用户登录,菜单显示。

用户名为admin2有用户角色的用户登录,菜单显示。

用户名为admin3有测试用户角色的用户登录,菜单显示。

3、案例代码下载

下载地址:https://github.com/machaoyin/SpringBoot-Security

最后有什么不足之处,欢迎大家指出,期待与你的交流。

来源:https://blog.csdn.net/qq_40205116/article/details/103739978
posted @ 2022-08-17 23:05  程序员小明1024  阅读(486)  评论(0编辑  收藏  举报