Spring Security將用戶數據存儲到數據庫的方法

一、UserDetailService

Spring Security 支持多種不同的數據源，這些不同的數據源最終都將被封裝成 UserDetailsService 的實例，在微人事（https://github.com/lenve/vhr）項目中，我們是自己來創建一個類實現 UserDetailsService 接口，除了自己封裝，我們也可以使用系統默認提供的 UserDetailsService 實例，例如上篇文章和大家介紹的 InMemoryUserDetailsManager 。

我們來看下 UserDetailsService 都有哪些實現類：

可以看到，在幾個能直接使用的實現類中，除了 InMemoryUserDetailsManager 之外，還有一個 JdbcUserDetailsManager，使用 JdbcUserDetailsManager 可以讓我們通過 JDBC 的方式將數據庫和 Spring Security 連接起來。

這里需要加入jdbc 和mysql 依賴：

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId></dependency><dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId></dependency>

二、JdbcUserDetailsManager

JdbcUserDetailsManager 自己提供了一個數據庫模型，這個數據庫模型保存在如下位置：

org/springframework/security/core/userdetails/jdbc/users.ddl

這里存儲的腳本內容如下：

create table users(username varchar_ignorecase(50) not null primary key,password varchar_ignorecase(500) not null,enabled boolean not null);create table authorities (username varchar_ignorecase(50) not null,authority varchar_ignorecase(50) not null,constraint fk_authorities_users foreign key(username) references users(username));create unique index ix_auth_username on authorities (username,authority);

可以看到，腳本中有一種數據類型 varchar_ignorecase，這個其實是針對 HSQLDB 數據庫創建的，而我們使用的 MySQL 并不支持這種數據類型，所以這里需要大家手動調整一下數據類型，將 varchar_ignorecase 改為 varchar 即可。

create table users(username varchar(50) not null primary key,password varchar(500) not null,enabled boolean not null);create table authorities (username varchar(50) not null,authority varchar(50) not null,constraint fk_authorities_users foreign key(username) references users(username));create unique index ix_auth_username on authorities (username,authority);

修改完成后，創建數據庫，執行完成后的腳本。

執行完 SQL 腳本后，我們可以看到一共創建了兩張表：users 和 authorities。

users 表中保存用戶的基本信息，包括用戶名、用戶密碼以及賬戶是否可用。authorities 中保存了用戶的角色。authorities 和 users 通過 username 關聯起來。

配置完成后，接下來，我們將上篇文章中通過 InMemoryUserDetailsManager 提供的用戶數據用 JdbcUserDetailsManager 代替掉，如下：

@Autowired DataSource dataSource; @Override @Bean protected UserDetailsService userDetailsService() { JdbcUserDetailsManager manager = new JdbcUserDetailsManager(); manager.setDataSource(dataSource); if (!manager.userExists('yolo')) { manager.createUser(User.withUsername('yolo').password('123').roles('admin').build()); } if (!manager.userExists('nlcs')) { manager.createUser(User.withUsername('nlcs').password('123').roles('user').build()); } return manager; }

這段配置的含義如下：

（1）首先構建一個 JdbcUserDetailsManager 實例。（2）給 JdbcUserDetailsManager 實例添加一個 DataSource 對象。（3）調用 userExists 方法判斷用戶是否存在，如果不存在，就創建一個新的用戶出來（因為每次項目啟動時這段代碼都會執行，所以加一個判斷，避免重復創建用戶）。（4）用戶的創建方法和我們之前 InMemoryUserDetailsManager 中的創建方法基本一致。

這里的 createUser 或者 userExists 方法其實都是調用寫好的 SQL 去判斷的，我們從它的源碼里就能看出來（部分）：

public class JdbcUserDetailsManager extends JdbcDaoImpl implements UserDetailsManager, GroupManager { public static final String DEF_USER_EXISTS_SQL = 'select username from users where username = ?'; private String userExistsSql = DEF_USER_EXISTS_SQL; public boolean userExists(String username) { List<String> users = getJdbcTemplate().queryForList(userExistsSql, new String[] { username }, String.class); if (users.size() > 1) { throw new IncorrectResultSizeDataAccessException( 'More than one user found with name ’' + username + '’', 1); } return users.size() == 1; }}

從這段源碼中就可以看出來，userExists 方法的執行邏輯其實就是調用 JdbcTemplate 來執行預定義好的 SQL 腳本，進而判斷出用戶是否存在，其他的判斷方法都是類似，我就不再贅述。

三、數據庫支持

通過前面的代碼，大家看到這里需要數據庫支持，所以我們在項目中添加如下兩個依賴：

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId></dependency><dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId></dependency>

然后再在 application.properties 中配置一下數據庫連接：

spring.datasource.username=rootspring.datasource.password=rootspring.datasource.url=jdbc:mysql://localhost:3306/security?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai

因為這里選擇的是 Mysql 8 所以配置信息里需要加入：serverTimezone=Asia/Shanghai

配置完成后，就可以啟動項目。

項目啟動成功后，我們就可以看到數據庫中自動添加了兩個用戶進來，并且用戶都配置了角色。如下圖：

四、測試登錄

接下來我們就可以進行測試了。

在測試的過程中，如果在數據庫中將用戶的 enabled 屬性設置為 false，表示禁用該賬戶，此時再使用該賬戶登錄就會登錄失敗。