S04L12 - 添加具有角色和权限的用户

html

在 Spring Boot 中实现 User Roles 和 Authorities：全面指南
目录

介绍 .................................................. 1
设置示例用户 .................... 3
为用户分配 Roles .................... 6
管理 Roles 和 Authorities ... 10
更新 Seed 数据 ................................ 14
实现 Authority Service ...... 18
在用户中使用 Authorities ................ 22
结论 ....................................................... 26


介绍
欢迎阅读 "Implementing User Roles and Authorities in Spring Boot: A Comprehensive Guide." 在本电子书中，我们将深入探讨在 Spring Boot 应用程序中管理 User Roles 和 Authorities 的复杂性。有效的用户管理对于确保任何 Web 应用程序的安全性和适当的访问控制至关重要。本指南将引导您完成设置示例用户、分配 Roles、管理 Authorities、更新 Seed 数据以及实施必要的服务，以无缝处理这些 Roles 和 Authorities 的过程。
User Roles 和 Authorities 的重要性
管理 User Roles 和 Authorities 对于以下方面至关重要：

安全性：确保用户仅访问其被允许的应用程序部分。
可扩展性：简化在应用程序增长时添加新 Roles 和权限的过程。
可维护性：通过分离与用户访问相关的关注点，使代码库更清晰、更有组织。

优缺点
优点：

通过实施访问控制增强安全性。
简化用户管理。
促进基于 Roles 的内容传递。

缺点：

初始设置可能较为复杂。
需要仔细规划以避免权限重叠或缺失。

何时以及在何处使用本指南
本指南非常适合初学者和具备基本 Spring Boot 知识的开发人员，他们旨在在应用程序中实现一个强大的用户管理系统。无论您是在构建博客平台、电子商务网站，还是任何需要 User Roles 的应用程序，本指南都提供了入门的基础步骤。

设置示例用户
在用户管理的初始阶段，建立一组示例用户以测试和演示角色分配是至关重要的。我们将创建四个用户：User、Admin、Editor 和 Super Editor。
创建示例用户




		
		
			
			
Java
			
			<pre>
// Sample users creation
Account user = new Account("user@user.com", "pass987");
Account admin = new Account("admin@admin.com", "pass987");
Account editor = new Account("editor@editor.com", "pass987");
Account superEditor = new Account("super@editor.com", "pass987");
			
				
					
				
					1
2
3
4
5
6
				
						<pre>
// Sample users creation
Account user = new Account("user@user.com", "pass987");
Account admin = new Account("admin@admin.com", "pass987");
Account editor = new Account("editor@editor.com", "pass987");
Account superEditor = new Account("super@editor.com", "pass987");
					
				
			
		



将 Roles 附加到用户
每个用户被分配一个特定的 Role：

Admin：被分配了 Admin 角色。
Editor：被分配了 Editor 角色。
Super Editor：同样被分配了 Editor 角色，并拥有额外的 authorities。
User：未附加特定角色；默认使用 User 角色。

默认角色机制
如果用户未附加特定角色，系统将默认自动分配 User 角色。这确保了每个用户都有一组基本的权限。

为用户分配 Roles
准确分配 Roles 是控制应用程序内访问权限的基础。让我们探讨如何将 Roles 附加到每个用户。
定义 Roles
首先，定义应用程序中可用的 Roles：




		
		
			
			
Java
			
			<pre>
// Defining roles
Role adminRole = new Role("ADMIN");
Role editorRole = new Role("EDITOR");
			
				
					
				
					1
2
3
4
				
						<pre>
// Defining roles
Role adminRole = new Role("ADMIN");
Role editorRole = new Role("EDITOR");
					
				
			
		



附加 Roles
将定义的 Roles 分配给相应的用户：




		
		
			
			
Java
			
			<pre>
// Attaching roles to users
admin.setRole(adminRole);
editor.setRole(editorRole);
superEditor.setRole(editorRole); // Super Editor will have additional authorities
// User will have the default role
			
				
					
				
					1
2
3
4
5
6
				
						<pre>
// Attaching roles to users
admin.setRole(adminRole);
editor.setRole(editorRole);
superEditor.setRole(editorRole); // Super Editor will have additional authorities
// User will have the default role
					
				
			
		



更新用户凭证
出于安全原因，更新用户凭证（如用户名和密码）是必要的：




		
		
			
			
Java
			
			<pre>
// Updating user credentials
admin.setPassword("passSecure123");
editor.setPassword("passSecure123");
superEditor.setPassword("passSecure123");
user.setPassword("passSecure123");
			
				
					
				
					1
2
3
4
5
6
				
						<pre>
// Updating user credentials
admin.setPassword("passSecure123");
editor.setPassword("passSecure123");
superEditor.setPassword("passSecure123");
user.setPassword("passSecure123");
					
				
			
		



> 注意： 确保密码符合安全标准以防止漏洞。

管理 Roles 和 Authorities
Roles 定义了用户 可以做什么，而 Authorities 指定了用户 可以访问什么。管理这两者对于一个安全高效的应用程序至关重要。
理解 Authorities
Authorities 是可以分配给 Roles 或直接分配给用户的细粒度权限。它们能够实现精细的访问控制。
建立获取机制
为了管理 Authorities，实施一种通过其唯一标识符 (ID) 获取它们的方法。




		
		
			
			
Java
			
			<pre>
// Authority service method to find by ID
public Optional<Authority> findById(Long id) {
    return authorityRepository.findById(id);
}
			
				
					
				
					1
2
3
4
5
				
						<pre>
// Authority service method to find by ID
public Optional<Authority> findById(Long id) {
    return authorityRepository.findById(id);
}
					
				
			
		




将 Authorities 关联到 Roles
为了增强功能，将特定的 Authorities 分配给 Roles。例如，Super Editor 角色可能拥有额外的特权，例如访问管理员面板和重置用户密码。




		
		
			
			
Java
			
			<pre>
// Assigning authorities to Super Editor
authorities.add(authorityService.findById(1L).ifPresent(authorities::add)); // Reset Password
authorities.add(authorityService.findById(2L).ifPresent(authorities::add)); // Access Admin Panel

superEditor.setAuthorities(authorities);
			
				
					
				
					1
2
3
4
5
6
				
						<pre>
// Assigning authorities to Super Editor
authorities.add(authorityService.findById(1L).ifPresent(authorities::add)); // Reset Password
authorities.add(authorityService.findById(2L).ifPresent(authorities::add)); // Access Admin Panel
 
superEditor.setAuthorities(authorities);
					
				
			
		





更新 Seed 数据
Seed 数据使用预定义的数据初始化您的数据库，确保从一开始就存在必要的 Roles 和 Authorities。
修改 Seed 数据
更新 Seed 数据以包括 Roles 和 Authorities。这一步确保在创建时每个用户都有必要的权限。




		
		
			
			
Java
			
			<pre>
// Updating seed data with authorities
Set<Authority> authorities = new HashSet<>();
authorityService.findById(1L).ifPresent(authorities::add);
authorityService.findById(2L).ifPresent(authorities::add);

superEditor.setAuthorities(authorities);
			
				
					
				
					1
2
3
4
5
6
7
				
						<pre>
// Updating seed data with authorities
Set<Authority> authorities = new HashSet<>();
authorityService.findById(1L).ifPresent(authorities::add);
authorityService.findById(2L).ifPresent(authorities::add);
 
superEditor.setAuthorities(authorities);
					
				
			
		




验证数据库条目
更新 Seed 数据后，验证 Authorities 是否在数据库中正确分配。




		
		
			
			
Java
			
			<pre>
// Sample SQL to verify authorities
SELECT * FROM authorities WHERE user_id = 4;
			
				
					
				
					1
2
3
				
						<pre>
// Sample SQL to verify authorities
SELECT * FROM authorities WHERE user_id = 4;
					
				
			
		




预期输出：


user_id
authority_id
authority_name


4
1
RESET_ANY_USER_PASSWORD


4
2
ACCESS_ADMIN_PANEL



实现 Authority Service
AuthorityService 负责管理应用程序中的 Authority 相关操作。
扩展 Authority Service
添加一个通过 ID 获取 Authorities 的方法，以实现向用户分配特定 Authorities。




		
		
			
			
Java
			
			<pre>
// AuthorityService.java
@Service
public class AuthorityService {
    
    @Autowired
    private AuthorityRepository authorityRepository;
    
    public Optional<Authority> findById(Long id) {
        return authorityRepository.findById(id);
    }
    
    // Additional methods as needed
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
				
						<pre>
// AuthorityService.java
@Service
public class AuthorityService {
    
    @Autowired
    private AuthorityRepository authorityRepository;
    
    public Optional<Authority> findById(Long id) {
        return authorityRepository.findById(id);
    }
    
    // Additional methods as needed
}
					
				
			
		




在 Seed 数据中利用该服务
在 Seed 数据中使用 AuthorityService 为用户分配 Authorities。




		
		
			
			
Java
			
			<pre>
// Assigning authorities using AuthorityService
Set<Authority> authorities = new HashSet<>();
authorityService.findById(1L).ifPresent(authorities::add); // RESET_ANY_USER_PASSWORD
authorityService.findById(2L).ifPresent(authorities::add); // ACCESS_ADMIN_PANEL

superEditor.setAuthorities(authorities);
			
				
					
				
					1
2
3
4
5
6
7
				
						<pre>
// Assigning authorities using AuthorityService
Set<Authority> authorities = new HashSet<>();
authorityService.findById(1L).ifPresent(authorities::add); // RESET_ANY_USER_PASSWORD
authorityService.findById(2L).ifPresent(authorities::add); // ACCESS_ADMIN_PANEL
 
superEditor.setAuthorities(authorities);
					
				
			
		





在用户中使用 Authorities
在定义并分配 Authorities 后，是时候将它们集成到用户帐户中，以控制应用程序内的访问。
将 Authorities 附加到用户
实施逻辑，将获取到的 Authorities 附加到相应的用户帐户。




		
		
			
			
Java
			
			<pre>
// Attaching authorities to user accounts
superEditor.setAuthorities(authorities);
			
				
					
				
					1
2
3
				
						<pre>
// Attaching authorities to user accounts
superEditor.setAuthorities(authorities);
					
				
			
		




管理多个 Authorities
单个用户可以拥有多个 Authorities，从而实现多样化的访问控制。




		
		
			
			
Java
			
			<pre>
// Example of assigning multiple authorities
if (authorityService.findById(1L).isPresent()) {
    authorities.add(authorityService.findById(1L).get());
}
if (authorityService.findById(2L).isPresent()) {
    authorities.add(authorityService.findById(2L).get());
}
superEditor.setAuthorities(authorities);
			
				
					
				
					1
2
3
4
5
6
7
8
9
				
						<pre>
// Example of assigning multiple authorities
if (authorityService.findById(1L).isPresent()) {
    authorities.add(authorityService.findById(1L).get());
}
if (authorityService.findById(2L).isPresent()) {
    authorities.add(authorityService.findById(2L).get());
}
superEditor.setAuthorities(authorities);
					
				
			
		




处理可选 Authorities
使用 Optional 来安全处理 Authorities 可能不存在的场景。




		
		
			
			
Java
			
			<pre>
// Safely adding authorities using Optional
authorityService.findById(1L).ifPresent(authorities::add);
authorityService.findById(2L).ifPresent(authorities::add);
superEditor.setAuthorities(authorities);
			
				
					
				
					1
2
3
4
5
				
						<pre>
// Safely adding authorities using Optional
authorityService.findById(1L).ifPresent(authorities::add);
authorityService.findById(2L).ifPresent(authorities::add);
superEditor.setAuthorities(authorities);
					
				
			
		




示例代码片段
以下是一个全面的示例，展示如何将 Authorities 分配给用户：




		
		
			
			
Java
			
			<pre>
// Example: Assigning authorities to Super Editor
Set<Authority> authorities = new HashSet<>();

// Fetch and add RESET_ANY_USER_PASSWORD authority
authorityService.findById(1L).ifPresent(authorities::add); 

// Fetch and add ACCESS_ADMIN_PANEL authority
authorityService.findById(2L).ifPresent(authorities::add); 

// Attach authorities to Super Editor
superEditor.setAuthorities(authorities);
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
				
						<pre>
// Example: Assigning authorities to Super Editor
Set<Authority> authorities = new HashSet<>();
 
// Fetch and add RESET_ANY_USER_PASSWORD authority
authorityService.findById(1L).ifPresent(authorities::add); 
 
// Fetch and add ACCESS_ADMIN_PANEL authority
authorityService.findById(2L).ifPresent(authorities::add); 
 
// Attach authorities to Super Editor
superEditor.setAuthorities(authorities);
					
				
			
		




输出解释
在执行上述代码后，Super Editor 用户将拥有两个 Authorities：

RESET_ANY_USER_PASSWORD：允许用户重置任何用户的密码。
ACCESS_ADMIN_PANEL：授予访问管理员面板的权限。

这确保了 Super Editor 相较于普通编辑者拥有更高的权限。

结论
在本指南中，我们探讨了在 Spring Boot 应用程序中实现 User Roles 和 Authorities 的关键步骤。通过设置示例用户、分配适当的 Roles、管理细粒度的 Authorities 以及更新 Seed 数据，您可以创建一个强大且安全的用户管理系统。实施服务来处理这些 Roles 和 Authorities 可确保在应用程序增长时的可扩展性和可维护性。
关键要点

Role Assignment：明确定义并分配 Roles 给用户，以有效管理访问。
Authority Management：使用 Authorities 进行细粒度权限控制。
Seed Data Updates：确保 Seed 数据包含必要的 Roles 和 Authorities 以进行初始设置。
Service Implementation：开发服务以无缝处理 Roles 和 Authorities 的分配与检索。
Security Enhancements：定期更新用户凭证并采用最佳实践以维护应用程序的安全性。

通过遵循这些步骤，您可以确保您的 Spring Boot 应用程序拥有坚实的用户管理基础，增强安全性和用户体验。
注意： 本文由 AI 生成。