使用 JPA 及 UserDetailsService

本文展示了如何使用 JPA 自定义 UserDetailsService 及数据库 的方式来进行认证。在本例，我们将认证信息存储于 H2 数据库中。

在 ldap-authentication项目的基础上，我们构建了一个jpa-userdetailsservice项目。

build.gradle

修改 build.gradle 文件，让我们的jpa-userdetailsservice项目成为一个新的项目。

修改内容也比较简单，修改项目名称及版本即可。

  1. jar {
  2.     baseName = 'jpa-userdetailsservice'
  3.     version = '1.0.0'
  4. }

我们将 spring-boot-starter-jdbc依赖改为了 spring-boot-starter-data-jpa

实体

修改 User

修改 User，增加了 username、password 两个字段，用于登录时使用。authorities 字段，用于存储该用户的权限信息。同时，User 也实现了 org.springframework.security.core.userdetails.UserDetails 接口。其中 User 与 Authority是多对多的关系。

  1. @Entity // 实体
  2. public class User implements UserDetails, Serializable {
  4.     private static final long serialVersionUID = 1L;
  6.     @Id // 主键
  7.     @GeneratedValue(strategy = GenerationType.IDENTITY) // 自增长策略
  8.     private Long id; // 用户的唯一标识
  10.     @Column(nullable = false, length = 50) // 映射为字段，值不能为空
  11.     private String name;
  13.     @Column(nullable = false)
  14.     private Integer age;
  16.     @Column(nullable = false, length = 50, unique = true)
  17.     private String username; // 用户账号，用户登录时的唯一标识
  19.     @Column(length = 100)
  20.     private String password; // 登录时密码
  22.     @ManyToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER)
  23.     @JoinTable(name = "user_authority", joinColumns = @JoinColumn(name = "user_id", referencedColumnName = "id"), 
  24.         inverseJoinColumns = @JoinColumn(name = "authority_id", referencedColumnName = "id"))
  25.     private List<Authority> authorities;
  27.     protected User() { // JPA 的规范要求无参构造函数；设为 protected 防止直接使用
  28.     }
  30.     public User(String name, Integer age) {
  31.         this.name = name;
  32.         this.age = age;
  33.     }
  35.     public Long getId() {
  36.         return id;
  37.     }
  39.     public void setId(Long id) {
  40.         this.id = id;
  41.     }
  43.     public String getName() {
  44.         return name;
  45.     }
  47.     public void setName(String name) {
  48.         this.name = name;
  49.     }
  51.     public Integer getAge() {
  52.         return age;
  53.     }
  55.     public void setAge(Integer age) {
  56.         this.age = age;
  57.     }
  59.     @Override
  60.     public Collection<? extends GrantedAuthority> getAuthorities() {
  61.         return this.authorities;
  62.     }
  64.     public void setAuthorities(List<Authority> authorities) {
  65.         this.authorities = authorities;
  66.     }
  68.     @Override
  69.     public String getUsername() {
  70.         return username;
  71.     }
  73.     public void setUsername(String username) {
  74.         this.username = username;
  75.     }
  77.     @Override
  78.     public String getPassword() {
  79.         return password;
  80.     }
  82.     public void setPassword(String password) {
  83.         this.password = password;
  84.     }
  86.     @Override
  87.     public boolean isAccountNonExpired() {
  88.         return true;
  89.     }
  91.     @Override
  92.     public boolean isAccountNonLocked() {
  93.         return true;
  94.     }
  96.     @Override
  97.     public boolean isCredentialsNonExpired() {
  98.         return true;
  99.     }
  101.     @Override
  102.     public boolean isEnabled() {
  103.         return true;
  104.     }
  106.     @Override
  107.     public String toString() {
  108.         return String.format("User[id=%d, username='%s', name='%s', age='%d', password='%s']", id, username, name, age,
  109.                 password);
  110.     }
  111. }

新增 Authority

新增 Authority 用于存储权限信息。 Authority 实现了 GrantedAuthority 接口，并重写了其 getAuthority 方法。

  1. @Entity // 实体
  2. public class Authority implements GrantedAuthority {
  4.     private static final long serialVersionUID = 1L;
  6.     @Id // 主键
  7.     @GeneratedValue(strategy = GenerationType.IDENTITY) // 自增长策略
  8.     private Long id; // 用户的唯一标识
  10.     @Column(nullable = false) // 映射为字段，值不能为空
  11.     private String name;
  13.     public Long getId() {
  14.         return id;
  15.     }
  17.     public void setId(Long id) {
  18.         this.id = id;
  19.     }
  21.     /*
  22.      * (non-Javadoc)
  23.      * 
  24.      * @see org.springframework.security.core.GrantedAuthority#getAuthority()
  25.      */
  26.     @Override
  27.     public String getAuthority() {
  28.         return name;
  29.     }
  31.     public void setName(String name) {
  32.         this.name = name;
  33.     }
  34. }

新增存储库

新增com.waylau.spring.boot.security.repository.UserRepository，由于继承自了 org.springframework.data.jpa.repository.JpaRepository接口，所以大部分与数据库操作的接口，我们在UserRepository都无需定义了。我们只需要定义一个

  1. public interface UserRepository extends JpaRepository<User, Long>{
  3.     User findByUsername(String username);
  4. }

findByUsername是用来根据用户账号来查询用户，这个在查询用户权限时要用到。

服务类

我们的服务类继承自我们定义的UserService，以及org.springframework.security.core.userdetails.UserDetailsService。其中，UserDetailsService是用来查询认证信息相关的接口，我们重写其loadUserByUsername方法。

  1. @Service
  2. public class UserServiceImpl implements UserService,UserDetailsService {
  4.     @Autowired
  5.     private UserRepository userRepository;
  7.     ......
  9.     @Override
  10.     public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
  11.         return userRepository.findByUsername(username);
  12.     }
  14. }

修改配置类 SecurityConfig

在配置类中，我们把 UserDetailsService 的实现赋给 AuthenticationManagerBuilder：

  1. @Autowired
  2. private UserDetailsService userDetailsService;
  3. ......
  5. /**
  6.  * 认证信息管理
  7.  * @param auth
  8.  * @throws Exception
  9.  */
  10. @Autowired
  11. public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
  12.     auth.userDetailsService(userDetailsService);
  13. }

初始化数据库

用于是使用了 JPA ，所以，默认表结构是会根据实体逆向生成的。

至于数据，我们在项目的 src/main/resources 目录下，放置一个 import.sql 脚本文件。里面是我们要初始化的数据，只要应用启动，就会自动把 import.sql 的数据给导入数据库。

以下为我们要初始化的数据：

  1. INSERT INTO user (id, username, password, name, age) VALUES (1, 'waylau', '123456', '老卫', 30);
  2. INSERT INTO user (id, username, password, name, age)  VALUES (2, 'admin', '123456', 'Way Lau', 29);
  4. INSERT INTO authority (id, name) VALUES (1, 'ROLE_USER');
  5. INSERT INTO authority (id, name) VALUES (2, 'ROLE_ADMIN');
  7. INSERT INTO user_authority (user_id, authority_id) VALUES (1, 1);
  8. INSERT INTO user_authority (user_id, authority_id) VALUES (2, 1);
  9. INSERT INTO user_authority (user_id, authority_id) VALUES (2, 2);