|
| 1 | +# admin security |
| 2 | + |
| 3 | +## USAGES |
| 4 | + |
| 5 | +1. 引入 pom |
| 6 | + |
| 7 | +``` |
| 8 | + <dependency> |
| 9 | + <groupId>com.admin4j.framework</groupId> |
| 10 | + <artifactId>security-spring-boot-starter</artifactId> |
| 11 | + <version>0.9.0</version> |
| 12 | + </dependency> |
| 13 | +``` |
| 14 | + |
| 15 | +2. 实现 JwtUserDetailsService 接口,用于根据用户ID获取用户详情。由于我们的JWT Token 存的是 userId,所以这里的入参为userId |
| 16 | + |
| 17 | +```java |
| 18 | + |
| 19 | +@Component |
| 20 | +public class Admin4jJwtUserDetailsService implements JwtUserDetailsService { |
| 21 | + |
| 22 | + @Autowired |
| 23 | + ISysUserLongInfoService sysUserLongInfoService; |
| 24 | + |
| 25 | + @Override |
| 26 | + public JwtUserDetails loadUserByUserId(Long userId) { |
| 27 | + |
| 28 | + return sysUserLongInfoService.getByUserId(userId); |
| 29 | + } |
| 30 | +} |
| 31 | +``` |
| 32 | + |
| 33 | +3. 账号密码登录。需要实现 `Spring Security`的`UserDetailsService` 接口，用于根据 username 查询用户详情 |
| 34 | + |
| 35 | +```java |
| 36 | + |
| 37 | +@Component |
| 38 | +public class Admin4jJwtUserDetailsService implements JwtUserDetailsService, UserDetailsService { |
| 39 | + |
| 40 | + @Autowired |
| 41 | + ISysUserLongInfoService sysUserLongInfoService; |
| 42 | + @Autowired |
| 43 | + ISysUserService sysUserService; |
| 44 | + |
| 45 | + @Override |
| 46 | + public JwtUserDetails loadUserByUserId(Long userId) { |
| 47 | + |
| 48 | + return sysUserLongInfoService.getByUserId(userId); |
| 49 | + } |
| 50 | + |
| 51 | + @Override |
| 52 | + public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { |
| 53 | + SysUser sysUser = sysUserService.getByUserName(username); |
| 54 | + return SysUserConvert.INSTANCE.convert(sysUser); |
| 55 | + } |
| 56 | +} |
| 57 | + |
| 58 | +``` |
| 59 | + |
| 60 | +### 测试 |
| 61 | + |
| 62 | +- 登录接口 |
| 63 | + |
| 64 | +```curl |
| 65 | +curl --location 'http://localhost:8080/login' \ |
| 66 | +--header 'Content-Type: application/x-www-form-urlencoded' \ |
| 67 | +--data-urlencode 'username=admin' \ |
| 68 | +--data-urlencode 'password=123456' |
| 69 | +``` |
| 70 | + |
| 71 | +- 返回结果 |
| 72 | + |
| 73 | +```json |
| 74 | +{ |
| 75 | + "code": 200, |
| 76 | + "data": { |
| 77 | + "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzYWx0IjoiMTIiLCJleHAiOjE2OTkzNDU3ODAsInVzZXJJRCI6MX0.tz0RGKSQEwfS0aTrsF7bdxF1enU4Vy32rn4ckDn3-D0" |
| 78 | + }, |
| 79 | + "msg": "success" |
| 80 | +} |
| 81 | +``` |
| 82 | + |
| 83 | +## 多渠道登录 |
| 84 | + |
| 85 | +通过配置的方式，支持微信，手机号等多渠道登录 |
| 86 | + |
| 87 | +### 验证码手机号登录 |
| 88 | + |
| 89 | +- yaml配置方式 |
| 90 | + |
| 91 | +```yaml |
| 92 | +admin4j: |
| 93 | + security: |
| 94 | + ignoring: |
| 95 | + uris: "login/sendPhoneCode" |
| 96 | + multi: |
| 97 | + auth-map: |
| 98 | + phone: phoneNumber |
| 99 | + |
| 100 | +``` |
| 101 | + |
| 102 | +auth-map 为渠道登录登录方式配置。对象类型，key为 登录方式 (`authType`)。value 为登录认证的字段名称。 |
| 103 | +解释如上配置， |
| 104 | + |
| 105 | +- 登录方式 (`authType`) : `phone` |
| 106 | +- 登录认证的字段名称: `phoneNumber` |
| 107 | +- ignoring.uris 忽略认证的接口。需要将发送验证码接口，忽略认证。 |
| 108 | + |
| 109 | +前端登录接口案例：`/login/phone` (/login/authType) |
| 110 | + |
| 111 | +```curl |
| 112 | +curl --location 'http://localhost:8080/login/phone' \ |
| 113 | +--header 'Content-Type: application/x-www-form-urlencoded' \ |
| 114 | + --data-urlencode 'phoneNumber=admin' \ |
| 115 | + --data-urlencode 'verificationCode=123456' |
| 116 | +``` |
| 117 | + |
| 118 | +- java 配置代码，实现接口`MultiUserDetailsService` |
| 119 | + 1. 配置登录方式 `support()` 为 phone （yaml配置的`authType`） |
| 120 | + 2. 检查手机对应的验证码是否正确 |
| 121 | + 3. 根据手机号获取用户详情 |
| 122 | + |
| 123 | +```java |
| 124 | + |
| 125 | +/** |
| 126 | + * 验证码手机号登录 |
| 127 | + * |
| 128 | + */ |
| 129 | +@Component |
| 130 | +public class PhoneMultiUserDetailsService implements MultiUserDetailsService { |
| 131 | + @Autowired |
| 132 | + ISysUserService sysUserService; |
| 133 | + |
| 134 | + @Override |
| 135 | + public String support() { |
| 136 | + return "phone"; |
| 137 | + } |
| 138 | + |
| 139 | + @Override |
| 140 | + public boolean preVerify(MultiAuthenticationToken multiAuthenticationToken) { |
| 141 | + |
| 142 | + // 验证码 |
| 143 | + String verificationCode = multiAuthenticationToken.getAuthParameter("verificationCode"); |
| 144 | + // TODO 验证验证码正确性。错误返回 false,或者抛出错误 |
| 145 | + return true; |
| 146 | + } |
| 147 | + |
| 148 | + @Override |
| 149 | + public UserDetails loadUserByMultiToken(String phoneNumber) { |
| 150 | + |
| 151 | + SysUser sysUser = sysUserService.getByPhoneNumber(phoneNumber); |
| 152 | + return SysUserConvert.INSTANCE.convert(sysUser); |
| 153 | + } |
| 154 | +} |
| 155 | + |
| 156 | +``` |
| 157 | + |
| 158 | +### 其他渠道登录，如微信openid 登录，参考上方可实现 |
0 commit comments