SpringDataJpa整合SpringSecurity进行用户权限存储

SpringDataJpa整合SpringSecurity进行用户权限存储

SpringData实现了java的jpa规范在数据持久化方面非常方便,而springSecurity在验证授权方面结合SpringBoot也十分方便.

1.导入相关的包这里使用的是gradle相关的包如下

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-jdbc'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-security'
    runtimeOnly 'mysql:mysql-connector-java'
    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
}

2.配置数据库等信息

spring.application.name=LearnSpringData
server.port=8080
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.name=defaultDataSource
spring.datasource.url=jdbc:mysql://localhost:3306/learnspringdata?serverTimezone=UTC
spring.datasource.username=******
spring.datasource.password=******
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.open-in-view = false

3.编写用户类User实现UserDetails接口,和权限类Role这两者之间是多对多的关系,所以需要一个之间表

//User类

@Entity(name = "t_user")
public class User implements UserDetails {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id; //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)
    @JoinTable(
            name = "t_user_roles",
            joinColumns = {@JoinColumn(name = "t_user_id")},
            inverseJoinColumns = {@JoinColumn(name = "roles_id")}
    )
    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

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

最后生成3张数据表如下图所示

4.Dao层

public interface RoleDao extends JpaRepository<Role,Long> {
    Role findByNameZh(String nameZh);
}

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

5.写UserService类实现UserDetailsService接口

//UserService

@Service
public class UserService implements UserDetailsService {

    UserDao userDao;

    @Autowired
    public void setUserDao(UserDao userDao) {
        this.userDao = userDao;
    }

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

6.配置SpringSecurity

@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    
    UserService userService;
    @Autowired
    public void setUserService(UserService userService) {
        this.userService = userService;
    }

    @Bean
    public BCryptPasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }

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

7.当用户登录成功时获取用户信息并在controller中返回

@RestController
public class index {
    /**
     * 获取登录成功的用户的信息
     * @param authentication 用户的相关信息
     * @return 用户的信息
     */
    @GetMapping("/")
    public Authentication getUserDetails(Authentication authentication){
        return authentication;
    }


}

8.在test中添加一些用户信息

public UserDao userDao;
    public RoleDao roleDao;
    public BCryptPasswordEncoder bCryptPasswordEncoder;
    @Autowired
    public void setRoleDao(RoleDao roleDao) {
        this.roleDao = roleDao;
    }
    @Autowired
    public void setUserDao(UserDao userDao) {
        this.userDao = userDao;
    }
    @Autowired
    public void setbCryptPasswordEncoder(BCryptPasswordEncoder bCryptPasswordEncoder) {
        this.bCryptPasswordEncoder = bCryptPasswordEncoder;
    }

    /**
     * 添加用户,包括用户的权限管理
     */
    @Test
    @Transactional
    @Commit
    void contextLoads() {
        String userName = "admin";
        String passWord = "admin";
        String roleZhName = "管理员";
        String roleName = "ROLE_admin";
        User user = new User();
        user.setUsername(userName);
        user.setPassword(bCryptPasswordEncoder.encode(passWord));
        user.setAccountNonExpired(true);
        user.setAccountNonLocked(true);
        user.setCredentialsNonExpired(true);
        user.setEnabled(true);
        List<Role> list = new ArrayList<>();
        Role role = roleDao.findByNameZh(roleZhName);
        if( role == null){
            role = new Role();
            role.setName(roleName);
            role.setNameZh(roleZhName);
        }
        System.out.println("++++++======\n\n\n"+role);
        list.add(role);
        user.setRoles(list);
        userDao.save(user);
    }

9.登录获取数据