S04L11 - 在 Spring Boot 中为用户账户添加权限

html

增强用户管理：在 Spring Boot 中添加 Authority 表
目录

介绍 ........................................................... 1
设置 Authority 实体 ............... 3
创建 Authority 仓库和服务 ................................................................. 7
使用 Enums 定义权限 .................. 11
填充种子数据 ......................................... 15
建立多对多关系 .................................................................................................... 19
结论 ............................................................. 25


介绍
在现代 Web 应用程序中，用户管理和授权是确保安全访问资源的关键组件。实施一个强大的 Authority 系统可以让开发人员有效地定义和管理用户角色及权限。本电子书深入探讨了在 Spring Boot 应用程序中向用户账户添加 Authority 表的过程，以增强安全性和可扩展性。
Authority 管理的重要性

安全性：限制对敏感功能的访问。
可扩展性：便于添加新角色和权限。
可维护性：简化用户权限的管理。

优缺点


优点
缺点


提高安全性和访问控制
初始设置可能耗时


易于管理用户角色和权限
需要仔细规划角色和权限


增强未来扩展的可扩展性
在较大应用中可能增加复杂性


何时何地使用

企业应用：管理多样化的用户角色。
电子商务平台：区分客户、供应商和管理员。
内容管理系统：控制内容创建和编辑的访问。


设置 Authority 实体
建立Authority实体是管理用户权限的基础。该实体通常包含一个ID和一个代表不同 Authority 的name。
创建 Authority 模型




		
		
			
			
Java
			
			package org.studyeasy.SpringBlog.models;

import javax.persistence.Entity;
import javax.persistence.Id;

@Entity
public class Authority {
    
    @Id
    private Long id;
    private String name;

    // Constructor
    public Authority(Long id, String name) {
        this.id = id;
        this.name = name;
    }

    // Getters
    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    // Setters
    public void setId(Long id) {
        this.id = id;
    }

    public void setName(String name) {
        this.name = name;
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
				
						package org.studyeasy.SpringBlog.models;
 
import javax.persistence.Entity;
import javax.persistence.Id;
 
@Entity
public class Authority {
    
    @Id
    private Long id;
    private String name;
 
    // Constructor
    public Authority(Long id, String name) {
        this.id = id;
        this.name = name;
    }
 
    // Getters
    public Long getId() {
        return id;
    }
 
    public String getName() {
        return name;
    }
 
    // Setters
    public void setId(Long id) {
        this.id = id;
    }
 
    public void setName(String name) {
        this.name = name;
    }
}
					
				
			
		


解释

@Entity：标记类为 JPA 实体。
@Id：表示主键。
字段：id 和 name 分别表示 Authority 的标识符及其名称。
构造函数 & Getters/Setters：便于对象创建和属性访问。


创建 Authority 仓库和服务
为了与Authority实体交互，我们需要创建一个repository和一个service层。
Authority Repository




		
		
			
			
Java
			
			package org.studyeasy.SpringBlog.repositories;

import org.springframework.data.jpa.repository.JpaRepository;
import org.studyeasy.SpringBlog.models.Authority;

public interface AuthorityRepository extends JpaRepository<Authority, Long> {
}
			
				
					
				
					1
2
3
4
5
6
7
				
						package org.studyeasy.SpringBlog.repositories;
 
import org.springframework.data.jpa.repository.JpaRepository;
import org.studyeasy.SpringBlog.models.Authority;
 
public interface AuthorityRepository extends JpaRepository<Authority, Long> {
}
					
				
			
		


Authority Service




		
		
			
			
Java
			
			package org.studyeasy.SpringBlog.services;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.studyeasy.SpringBlog.models.Authority;
import org.studyeasy.SpringBlog.repositories.AuthorityRepository;

@Service
public class AuthorityService {

    @Autowired
    private AuthorityRepository authorityRepository;

    public Authority save(Authority authority) {
        return authorityRepository.save(authority);
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
				
						package org.studyeasy.SpringBlog.services;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.studyeasy.SpringBlog.models.Authority;
import org.studyeasy.SpringBlog.repositories.AuthorityRepository;
 
@Service
public class AuthorityService {
 
    @Autowired
    private AuthorityRepository authorityRepository;
 
    public Authority save(Authority authority) {
        return authorityRepository.save(authority);
    }
}
					
				
			
		


解释

AuthorityRepository：扩展 JpaRepository，为 Authority 实体提供 CRUD 操作。
AuthorityService：使用 AuthorityRepository 来管理 Authorities，封装业务逻辑。


使用 Enums 定义权限
Enums 是定义一组固定常量（如用户权限）的有效方式。
创建 Privileges Enum




		
		
			
			
Java
			
			package org.studyeasy.SpringBlog.util.constants;

public enum Privileges {
    RESET_PASSWORD(1L, "RESET_PASSWORD"),
    ACCESS_ADMIN_PANEL(2L, "ACCESS_ADMIN_PANEL");

    private Long id;
    private String name;

    Privileges(Long id, String name) {
        this.id = id;
        this.name = name;
    }

    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
				
						package org.studyeasy.SpringBlog.util.constants;
 
public enum Privileges {
    RESET_PASSWORD(1L, "RESET_PASSWORD"),
    ACCESS_ADMIN_PANEL(2L, "ACCESS_ADMIN_PANEL");
 
    private Long id;
    private String name;
 
    Privileges(Long id, String name) {
        this.id = id;
        this.name = name;
    }
 
    public Long getId() {
        return id;
    }
 
    public String getName() {
        return name;
    }
}
					
				
			
		


解释

Enum 常量：RESET_PASSWORD 和 ACCESS_ADMIN_PANEL 代表不同的权限。
字段：每个 enum 常量都有一个 id 和一个 name。
构造函数 & Getters：便于创建和检索权限属性。


填充种子数据
种子数据在数据库中初始化默认 Authorities，确保在应用程序启动时具有必要的角色。
实现种子数据




		
		
			
			
Java
			
			package org.studyeasy.SpringBlog.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import org.studyeasy.SpringBlog.models.Authority;
import org.studyeasy.SpringBlog.services.AuthorityService;
import org.studyeasy.SpringBlog.util.constants.Privileges;

@Component
public class SeedData implements CommandLineRunner {

    @Autowired
    private AuthorityService authorityService;

    @Override
    public void run(String... args) throws Exception {
        for (Privileges privilege : Privileges.values()) {
            Authority authority = new Authority();
            authority.setId(privilege.getId());
            authority.setName(privilege.getName());
            authorityService.save(authority);
        }
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
				
						package org.studyeasy.SpringBlog.config;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import org.studyeasy.SpringBlog.models.Authority;
import org.studyeasy.SpringBlog.services.AuthorityService;
import org.studyeasy.SpringBlog.util.constants.Privileges;
 
@Component
public class SeedData implements CommandLineRunner {
 
    @Autowired
    private AuthorityService authorityService;
 
    @Override
    public void run(String... args) throws Exception {
        for (Privileges privilege : Privileges.values()) {
            Authority authority = new Authority();
            authority.setId(privilege.getId());
            authority.setName(privilege.getName());
            authorityService.save(authority);
        }
    }
}
					
				
			
		


解释

@Component：将该类注册为 Spring bean。
CommandLineRunner：在应用程序启动后执行 run 方法。
遍历 Privileges：迭代所有 enum 值，创建并保存相应的 Authorities。
错误处理：通过确保数据类型一致（Long vs. int）解决类型不匹配等小问题。

种子数据执行结果
运行应用程序后，Authority 表会被填充定义的权限：


ID
名称


1
RESET_PASSWORD


2
ACCESS_ADMIN_PANEL



建立多对多关系
为了将用户与多个 Authorities 互相关联，Account 和 Authority 实体之间建立了多对多关系。
更新 Account 模型




		
		
			
			
Java
			
			package org.studyeasy.SpringBlog.models;

import javax.persistence.*;
import java.util.HashSet;
import java.util.Set;

@Entity
public class Account {

    @Id
    private Long id;
    private String username;
    private String password;

    @ManyToMany
    @JoinTable(
        name = "account_authority",
        joinColumns = @JoinColumn(name = "account_id", referencedColumnName = "id"),
        inverseJoinColumns = @JoinColumn(name = "authority_id", referencedColumnName = "id")
    )
    private Set<Authority> authorities = new HashSet<>();

    // Constructors, Getters, and Setters
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
				
						package org.studyeasy.SpringBlog.models;
 
import javax.persistence.*;
import java.util.HashSet;
import java.util.Set;
 
@Entity
public class Account {
 
    @Id
    private Long id;
    private String username;
    private String password;
 
    @ManyToMany
    @JoinTable(
        name = "account_authority",
        joinColumns = @JoinColumn(name = "account_id", referencedColumnName = "id"),
        inverseJoinColumns = @JoinColumn(name = "authority_id", referencedColumnName = "id")
    )
    private Set<Authority> authorities = new HashSet<>();
 
    // Constructors, Getters, and Setters
}
					
				
			
		


解释

@ManyToMany：定义 Account 和 Authority 之间的多对多关系。
@JoinTable：指定连接表 account_authority 用于促进关系。

joinColumns：引用 Account 实体。
inverseJoinColumns：引用 Authority 实体。


Set<Authority>：使用 Set 防止一个账户拥有重复的 Authorities。

创建连接表
基于注解，account_authority 连接表会自动创建，其结构如下：


列名
数据类型
约束


account_id
Long
外键到 Account.id


authority_id
Long
外键到 Authority.id


多对多关系的好处

灵活性：允许每个用户拥有多个 Authorities，反之亦然。
数据完整性：通过连接表确保数据的一致性和非冗余。


结论
在 Spring Boot 应用程序中实现 Authority 表对于强大的用户管理和授权至关重要。本综合指南涵盖了以下关键步骤：

设置 Authority 实体：建立一个基础实体以表示用户角色。
创建 Authority 仓库和服务：促进数据访问和业务逻辑。
使用 Enums 定义权限：枚举不同的用户权限以确保清晰和一致。
填充种子数据：确保在应用程序启动时初始化必要的角色。
建立多对多关系：实现用户与其 Authorities 之间的灵活关联。

通过遵循这些步骤，开发人员可以在 Spring Boot 应用程序中创建一个安全且可扩展的 Authority 管理系统。
SEO 优化关键词
Spring Boot authority tables, user management Spring Boot, Spring Boot authorization, many-to-many Spring Boot, Spring Boot security, defining privileges Spring Boot, Spring Boot seed data, Authority entity Spring Boot, Spring Boot user roles, Spring Boot application security
注意：本文由 AI 生成。
优点	缺点
提高安全性和访问控制	初始设置可能耗时
易于管理用户角色和权限	需要仔细规划角色和权限
增强未来扩展的可扩展性	在较大应用中可能增加复杂性
列名	数据类型	约束
account_id	Long	外键到 Account.id
authority_id	Long	外键到 Authority.id