Spring Security+Spring Data Jpa如何進行安全管理
為了操作簡單,我這裡引入 Spring Data Jpa 來幫助我們完成資料庫操作
1.建立工程
首先我們建立一個新的 Spring Boot 工程,新增如下依賴:
注意,除了 Spring Security 依賴之外,我們還需要資料依賴和 Spring Data Jpa 依賴。
工程建立完成後,我們再在資料庫中建立一個空的庫,就叫做 withjpa,裡邊什麼都不用做,這樣我們的準備工作就算完成了。
2.準備模型
接下來我們建立兩個實體類,分別表示使用者角色了使用者類:
使用者角色:
@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 表示這是一個實體類,專案啟動後,將會根據實體類的屬性在資料庫中自動建立一個角色表。
使用者實體類:
@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 介面,並實現介面中的方法。
這裡的欄位基本都好理解,幾個特殊的我來稍微說一下:
- accountNonExpired、accountNonLocked、credentialsNonExpired、enabled 這四個屬性分別用來描述使用者的狀態,表示賬戶是否沒有過期、賬戶是否沒有被鎖定、密碼是否沒有過期、以及賬戶是否可用。
- roles 屬性表示使用者的角色,User 和 Role 是多對多關係,用一個 @ManyToMany 註解來描述。
- getAuthorities 方法返回使用者的角色資訊,我們在這個方法中把自己的 Role 稍微轉化一下即可。
3.配置
資料模型準備好之後,我們再來定義一個 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 我還是沿用之前文章中的(Spring Security 如何將使用者資料存入資料庫?),主要列出來需要修改的地方。
在 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=123 spring.datasource.url=jdbc:mysql:///withjpa?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
都是常規配置,我們就不再重複解釋了。
這一套組合拳下來,我們的 Spring Security 就算是接入資料庫了,接下來我們來進行測試
4.測試
首先我們來新增兩條測試資料,在單元測試中新增如下方法:
@Autowired UserDao userDao; @Test void contextLoads() { User u1 = new User(); u1.setUsername("javaboy"); u1.setPassword("123"); u1.setAccountNonExpired(true); u1.setAccountNonLocked(true); u1.setCredentialsNonExpired(true); u1.setEnabled(true); List<Role> rs1 = new ArrayList<>(); Role r1 = new Role(); r1.setName("ROLE_admin"); r1.setNameZh("管理員"); rs1.add(r1); u1.setRoles(rs1); userDao.save(u1); User u2 = new User(); u2.setUsername("江南一點雨"); u2.setPassword("123"); u2.setAccountNonExpired(true); u2.setAccountNonLocked(true); u2.setCredentialsNonExpired(true); u2.setEnabled(true); List<Role> rs2 = new ArrayList<>(); Role r2 = new Role(); r2.setName("ROLE_user"); r2.setNameZh("普通使用者"); rs2.add(r2); u2.setRoles(rs2); userDao.save(u2); }
執行該方法後,我們會發現資料庫中多了三張表:
這就是根據我們的實體類自動創建出來的。
我們來檢視一下表中的資料。
使用者表:
角色表:
使用者和角色關聯表:
有了資料,接下來啟動專案,我們來進行測試。
我們首先以 江南一點雨的身份進行登入:
登入成功後,分別訪問 /hello,/admin/hello 以及 /user/hello 三個介面,其中:
- /hello 因為登入後就可以訪問,這個介面訪問成功。
- /admin/hello 需要 admin 身份,所以訪問失敗。
- /user/hello 需要 user 身份,所以訪問成功。
具體測試效果小夥伴們可以參考鬆哥的視訊,我就不截圖了。
在測試的過程中,如果在資料庫中將使用者的 enabled 屬性設定為 false,表示禁用該賬戶,此時再使用該賬戶登入就會登入失敗。
按照相同的方式,大家也可以測試 javaboy 使用者。
好了,今天就和小夥伴們說這麼多.
以上就是Spring Security+Spring Data Jpa如何進行安全管理的詳細內容,更多關於Spring Security+Spring Data Jpa 安全管理的資料請關注我們其它相關文章!