一篇文章带你搞定 SpringSecurity 和 SpringDataJpa 的整合

桃扇骨 2022-12-07 12:19 274阅读 0赞

关于 SpringDataJpa 的学习可以参考：[学习 Spring Data JPA 一篇文章就够了][Spring Data JPA]

### 文章目录 ###

*   *  一、创建工程
     *  二、准备模型
     *  三、配置
     *  四、测试

## 一、创建工程 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmh1YWliZWlhbg_size_16_color_FFFFFF_t_70_pic_center]  
注意，除了 Spring Security 依赖之外，我们还需要数据依赖和 Spring Data Jpa 依赖。

工程创建完成后，我们再在数据库中创建一个空的库，就叫做 jpa，里边什么都不用做，这样我们的准备工作就算完成了。

## 二、准备模型 ##

（1）角色实体类：

@Entity(name = "t_role")
    public class Role { 
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long id;
        private String name;
        private String nameZh;
        //省略 getter/setter
    }

这个实体类用来描述用户角色信息，有角色 id、角色名称（英文、中文），`@Entity` 表示这是一个实体类，项目启动后，将会根据实体类的属性在数据库中自动创建一个角色表。  
（2）用户实体类

@Entity(name = "t_user")
    public class User implements UserDetails { 
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long id;
        private String username;
        private String password;
        private boolean accountNonExpired;
        private boolean accountNonLocked;
        private boolean credentialsNonExpired;
        private boolean enabled;
        @ManyToMany(fetch = FetchType.EAGER,cascade = CascadeType.PERSIST)
        private List<Role> roles;
        @Override
        public Collection<? extends GrantedAuthority> getAuthorities() { 
            List<SimpleGrantedAuthority> authorities = new ArrayList<>();
            for (Role role : getRoles()) { 
                authorities.add(new SimpleGrantedAuthority(role.getName()));
            }
            return authorities;
        }
        @Override
        public String getPassword() { 
            return password;
        }
    
        @Override
        public String getUsername() { 
            return username;
        }
    
        @Override
        public boolean isAccountNonExpired() { 
            return accountNonExpired;
        }
    
        @Override
        public boolean isAccountNonLocked() { 
            return accountNonLocked;
        }
    
        @Override
        public boolean isCredentialsNonExpired() { 
            return credentialsNonExpired;
        }
    
        @Override
        public boolean isEnabled() { 
            return enabled;
        }
        //省略其他 get/set 方法
    }

用户实体类主要需要实现 `UserDetails` 接口，并实现接口中的方法。

这里的字段基本都好理解，几个特殊的我来稍微说一下：

> （1） `accountNonExpired`、`accountNonLocked`、`credentialsNonExpired`、`enabled` 这四个属性分别用来描述用户的状态，表示账户是否没有过期、账户是否没有被锁定、密码是否没有过期、以及账户是否可用。  
> （2）roles 属性表示用户的角色，User 和 Role 是多对多关系，用一个 `@ManyToMany` 注解来描述。  
> （3）getAuthorities 方法返回用户的角色信息，我们在这个方法中把自己的 Role 稍微转化一下即可。

## 三、配置 ##

数据模型准备好之后，我们再来定义一个 UserDao：

public interface UserDao extends JpaRepository<User,Long> { 
        User findUserByUsername(String username);
    }

这里的东西很简单，我们只需要继承 `JpaRepository` 然后提供一个根据 username 查询 user 的方法即可。  
在接下来定义 UserService ，如下：

@Service
    public class UserService implements UserDetailsService { 
        @Autowired
        UserDao userDao;
        @Override
        public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { 
            User user = userDao.findUserByUsername(username);
            if (user == null) { 
                throw new UsernameNotFoundException("用户不存在");
            }
            return user;
        }
    }

我们自己定义的 `UserService` 需要实现 `UserDetailsService` 接口，实现该接口，就要实现接口中的方法，也就是 `loadUserByUsername` ，这个方法的参数就是用户在登录的时候传入的用户名，根据用户名去查询用户信息（查出来之后，系统会自动进行密码比对）。

配置完成后，接下来我们在 Spring Security 中稍作配置，Spring Security 和测试用的 HelloController 我还是沿用之前文章中的，主要列出来需要修改的地方。

在 SecurityConfig 中，我们通过如下方式来配置用户：

@Autowired
    UserService userService;
    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception { 
        auth.userDetailsService(userService);
    }

大家注意，还是重写 configure 方法，只不过这次我们不是基于内存，也不是基于 `JdbcUserDetailsManager`，而是使用自定义的 `UserService`，就这样配置就 OK 了。

最后，我们再在 application.properties 中配置一下数据库和 JPA 的基本信息，如下：

spring.datasource.username=root
    spring.datasource.password=root
    spring.datasource.url=jdbc:mysql://localhost:3306/jpa?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    
    spring.jpa.database=mysql
    spring.jpa.database-platform=mysql
    spring.jpa.hibernate.ddl-auto=update
    spring.jpa.show-sql=true
    spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL8Dialect

## 四、测试 ##

首先我们来添加测试数据，在单元测试中添加如下方法：

@Test
        void contextLoads() { 
            User user = new User();
            user.setUsername("yolo");
            user.setPassword("123");
            user.setAccountNonExpired(true);
            user.setAccountNonLocked(true);
            user.setCredentialsNonExpired(true);
            user.setEnabled(true);
            List<Role> list = new ArrayList<>();
            Role role = new Role();
            role.setName("ROLE_admin");
            role.setNameZh("管理员");
            list.add(role);
            user.setRoles(list);
            userDao.save(user);
        }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmh1YWliZWlhbg_size_16_color_FFFFFF_t_70_pic_center 1]  
登录成功后，分别访问 `/hello，/admin/hello` 以及 `/user/hello` 三个接口，其中：

> （1）`/hello` 因为登录后就可以访问，这个接口访问成功。  
> （2）`/admin/hello` 需要 admin 身份，所以访问失败。  
> （3）`/user/hello` 需要 user 身份，所以访问成功。

[Spring Data JPA]: https://blog.csdn.net/nanhuaibeian/article/details/107239604
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmh1YWliZWlhbg_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/763882ca9e4a4df3b465914fcfda536b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmh1YWliZWlhbg_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/62e3c77fdf5a4617b00c13f79a79a5ba.png