Para aprender sobre Spring Data Jpa, você pode consultar: Um artigo é o suficiente para aprender Spring Data JPA
Artigo Diretório
Um, crie um projeto
Observe que, além das dependências do Spring Security, também precisamos das dependências de dados e do Spring Data Jpa.
Após a criação do projeto, criamos uma biblioteca vazia no banco de dados, chamada jpa, sem fazer nada nela, para que nosso trabalho preparatório seja concluído.
Dois, prepare o modelo
(1) Classe de entidade de função:
@Entity(name = "t_role")
public class Role {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private String name;
private String nameZh;
//省略 getter/setter
}
Esta classe de entidade é usada para descrever as informações da função do usuário. Ela tem o id e o nome da função (inglês, chinês), @Entity
indicando que se trata de uma classe de entidade. Depois que o projeto for iniciado, uma tabela de funções será criada automaticamente no banco de dados com base nos atributos da classe de entidade.
(2) Classe de entidade do usuário
@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 方法
}
O principal da entidade do usuário precisa implementar UserDetails
a interface e a implementação do método de interface.
Os campos aqui são basicamente fáceis de entender, deixe-me falar sobre alguns especiais:
(1)
accountNonExpired
,accountNonLocked
,credentialsNonExpired
,enabled
quatro atributos são usados para descrever o estado do usuário, indicando se a conta não expirou, se a conta não está bloqueado, se a senha não expirou, e a conta está disponível.
(2) o atributo de funções representa a função do usuário, o usuário e o relacionamento entre muitas funções com uma@ManyToMany
anotação descrita.
(3) O método getAuthorities retorna as informações do papel do usuário, neste método podemos transformar um pouco o nosso papel.
Três, configuração
Depois que o modelo de dados estiver pronto, vamos definir um UserDao:
public interface UserDao extends JpaRepository<User,Long> {
User findUserByUsername(String username);
}
Aqui está algo muito simples, precisamos apenas herdar JpaRepository
e fornecer um método de acordo com o nome de usuário da consulta do usuário.
Defina UserService a seguir, da seguinte maneira:
@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);
}
登录成功后,分别访问 /hello,/admin/hello
以及 /user/hello
三个接口,其中:
(1)
/hello
因为登录后就可以访问,这个接口访问成功。
(2)/admin/hello
需要 admin 身份,所以访问失败。
(3)/user/hello
需要 user 身份,所以访问成功。