userDetailsLoader.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
  1. package loaders
  2. import (
  3. "context"
  4. "encoding/json"
  5. "fmt"
  6. "math"
  7. "perms-system-server/internal/consts"
  8. "perms-system-server/internal/model"
  9. "perms-system-server/internal/model/productmember"
  10. "github.com/zeromicro/go-zero/core/logx"
  11. "github.com/zeromicro/go-zero/core/stores/redis"
  12. "golang.org/x/sync/singleflight"
  13. )
  14. const defaultCacheTTL = 300 // 5 分钟
  15. // -------- UserDetails 及子结构 --------
  16. // UserDetails 用户完整信息,包含用户、部门、产品、成员、角色、权限等所有有效字段。
  17. // 由 UserDetailsLoader 一次性加载,可用于中间件 context 注入、login/userInfo 响应、Claims 构造等。
  18. type UserDetails struct {
  19. // 用户基本信息 (sys_user)
  20. UserId int64 `json:"userId"`
  21. Username string `json:"username"`
  22. Nickname string `json:"nickname"`
  23. Avatar string `json:"avatar"`
  24. Email string `json:"email"`
  25. Phone string `json:"phone"`
  26. Remark string `json:"remark"`
  27. IsSuperAdmin bool `json:"isSuperAdmin"`
  28. IsSuperAdminRaw int64 `json:"isSuperAdminRaw"`
  29. MustChangePassword bool `json:"mustChangePassword"`
  30. MustChangePwdRaw int64 `json:"mustChangePwdRaw"`
  31. Status int64 `json:"status"`
  32. // 部门信息 (sys_dept)
  33. DeptId int64 `json:"deptId"`
  34. DeptName string `json:"deptName"`
  35. DeptPath string `json:"deptPath"`
  36. DeptType string `json:"deptType"`
  37. // 产品上下文 (sys_product)
  38. ProductCode string `json:"productCode"`
  39. ProductName string `json:"productName"`
  40. // 成员信息 (sys_product_member)
  41. MemberType string `json:"memberType"`
  42. // 角色列表 (sys_role,当前产品下已启用的角色)
  43. Roles []RoleInfo `json:"roles"`
  44. // 权限列表 (计算后的权限 code 集合)
  45. Perms []string `json:"perms"`
  46. // 当前产品下最小 permsLevel(无角色时为 math.MaxInt64)
  47. MinPermsLevel int64 `json:"minPermsLevel"`
  48. }
  49. // RoleInfo 角色摘要信息。
  50. type RoleInfo struct {
  51. Id int64 `json:"id"`
  52. Name string `json:"name"`
  53. Remark string `json:"remark"`
  54. PermsLevel int64 `json:"permsLevel"`
  55. }
  56. // -------- UserDetailsLoader --------
  57. // UserDetailsLoader 负责加载、缓存、失效用户详细信息。
  58. // 优先从 Redis 读取完整 UserDetails,miss 时查 DB 并回填。
  59. type UserDetailsLoader struct {
  60. rds *redis.Redis
  61. keyPrefix string
  62. ttl int
  63. models *model.Models
  64. sf singleflight.Group
  65. }
  66. func NewUserDetailsLoader(rds *redis.Redis, keyPrefix string, models *model.Models) *UserDetailsLoader {
  67. return &UserDetailsLoader{
  68. rds: rds,
  69. keyPrefix: keyPrefix,
  70. ttl: defaultCacheTTL,
  71. models: models,
  72. }
  73. }
  74. func (l *UserDetailsLoader) cacheKey(userId int64, productCode string) string {
  75. return fmt.Sprintf("%s:ud:%d:%s", l.keyPrefix, userId, productCode)
  76. }
  77. // Load 根据 userId 和 productCode 加载完整的 UserDetails。
  78. func (l *UserDetailsLoader) Load(ctx context.Context, userId int64, productCode string) *UserDetails {
  79. key := l.cacheKey(userId, productCode)
  80. if val, err := l.rds.GetCtx(ctx, key); err == nil && val != "" {
  81. var ud UserDetails
  82. if err := json.Unmarshal([]byte(val), &ud); err == nil {
  83. return &ud
  84. }
  85. }
  86. v, _, _ := l.sf.Do(key, func() (interface{}, error) {
  87. ud, ok := l.loadFromDB(ctx, userId, productCode)
  88. if ok {
  89. if val, err := json.Marshal(ud); err == nil {
  90. if err := l.rds.SetexCtx(ctx, key, string(val), l.ttl); err != nil {
  91. logx.WithContext(ctx).Errorf("set user details cache failed: %v", err)
  92. }
  93. }
  94. }
  95. return ud, nil
  96. })
  97. return v.(*UserDetails)
  98. }
  99. // Del 删除指定用户在指定产品下的缓存。
  100. func (l *UserDetailsLoader) Del(ctx context.Context, userId int64, productCode string) {
  101. key := l.cacheKey(userId, productCode)
  102. if _, err := l.rds.DelCtx(ctx, key); err != nil {
  103. logx.WithContext(ctx).Errorf("del user details cache [%s] failed: %v", key, err)
  104. }
  105. }
  106. // Clean 清除指定用户所有产品下的缓存。
  107. func (l *UserDetailsLoader) Clean(ctx context.Context, userId int64) {
  108. pattern := fmt.Sprintf("%s:ud:%d:*", l.keyPrefix, userId)
  109. l.cleanByPattern(ctx, pattern)
  110. }
  111. // CleanByProduct 清除指定产品下所有用户的缓存。
  112. func (l *UserDetailsLoader) CleanByProduct(ctx context.Context, productCode string) {
  113. pattern := fmt.Sprintf("%s:ud:*:%s", l.keyPrefix, productCode)
  114. l.cleanByPattern(ctx, pattern)
  115. }
  116. // BatchDel 批量删除多个用户在指定产品下的缓存。
  117. func (l *UserDetailsLoader) BatchDel(ctx context.Context, userIds []int64, productCode string) {
  118. if len(userIds) == 0 {
  119. return
  120. }
  121. keys := make([]string, 0, len(userIds))
  122. for _, uid := range userIds {
  123. keys = append(keys, l.cacheKey(uid, productCode))
  124. }
  125. if _, err := l.rds.DelCtx(ctx, keys...); err != nil {
  126. logx.WithContext(ctx).Errorf("batch del user details cache failed: %v", err)
  127. }
  128. }
  129. // NOTE: SCAN only works on single-node Redis. For Redis Cluster, consider using hash tags
  130. // in key design or switching to a different cache invalidation strategy.
  131. func (l *UserDetailsLoader) cleanByPattern(ctx context.Context, pattern string) {
  132. var cursor uint64
  133. for {
  134. keys, cur, err := l.rds.ScanCtx(ctx, cursor, pattern, 100)
  135. if err != nil {
  136. logx.WithContext(ctx).Errorf("scan keys [%s] failed: %v", pattern, err)
  137. return
  138. }
  139. if len(keys) > 0 {
  140. if _, err := l.rds.DelCtx(ctx, keys...); err != nil {
  141. logx.WithContext(ctx).Errorf("del keys failed: %v", err)
  142. }
  143. }
  144. if cur == 0 {
  145. return
  146. }
  147. cursor = cur
  148. }
  149. }
  150. // -------- 内部加载逻辑 --------
  151. func (l *UserDetailsLoader) loadFromDB(ctx context.Context, userId int64, productCode string) (*UserDetails, bool) {
  152. ud := &UserDetails{
  153. UserId: userId,
  154. ProductCode: productCode,
  155. MinPermsLevel: math.MaxInt64,
  156. }
  157. if !l.loadUser(ctx, ud) {
  158. return ud, false
  159. }
  160. l.loadDept(ctx, ud)
  161. l.loadProduct(ctx, ud)
  162. l.loadMembership(ctx, ud)
  163. l.loadRoles(ctx, ud)
  164. l.loadPerms(ctx, ud)
  165. return ud, true
  166. }
  167. func (l *UserDetailsLoader) loadUser(ctx context.Context, ud *UserDetails) bool {
  168. u, err := l.models.SysUserModel.FindOne(ctx, ud.UserId)
  169. if err != nil {
  170. logx.WithContext(ctx).Errorf("userDetailsLoader: query user %d failed: %v", ud.UserId, err)
  171. return false
  172. }
  173. ud.Username = u.Username
  174. ud.Nickname = u.Nickname
  175. ud.Avatar = u.Avatar.String
  176. ud.Email = u.Email
  177. ud.Phone = u.Phone
  178. ud.Remark = u.Remark
  179. ud.DeptId = u.DeptId
  180. ud.IsSuperAdminRaw = u.IsSuperAdmin
  181. ud.IsSuperAdmin = u.IsSuperAdmin == consts.IsSuperAdminYes
  182. ud.MustChangePwdRaw = u.MustChangePassword
  183. ud.MustChangePassword = u.MustChangePassword == consts.MustChangePasswordYes
  184. ud.Status = u.Status
  185. return true
  186. }
  187. func (l *UserDetailsLoader) loadDept(ctx context.Context, ud *UserDetails) {
  188. if ud.DeptId == 0 {
  189. return
  190. }
  191. d, err := l.models.SysDeptModel.FindOne(ctx, ud.DeptId)
  192. if err != nil {
  193. logx.WithContext(ctx).Errorf("userDetailsLoader: query dept %d failed: %v", ud.DeptId, err)
  194. return
  195. }
  196. ud.DeptName = d.Name
  197. ud.DeptPath = d.Path
  198. ud.DeptType = d.DeptType
  199. }
  200. func (l *UserDetailsLoader) loadProduct(ctx context.Context, ud *UserDetails) {
  201. if ud.ProductCode == "" {
  202. return
  203. }
  204. p, err := l.models.SysProductModel.FindOneByCode(ctx, ud.ProductCode)
  205. if err != nil {
  206. logx.WithContext(ctx).Errorf("userDetailsLoader: query product %s failed: %v", ud.ProductCode, err)
  207. return
  208. }
  209. ud.ProductName = p.Name
  210. }
  211. func (l *UserDetailsLoader) loadMembership(ctx context.Context, ud *UserDetails) {
  212. if ud.IsSuperAdmin {
  213. ud.MemberType = consts.MemberTypeSuperAdmin
  214. }
  215. if ud.ProductCode == "" {
  216. return
  217. }
  218. if ud.IsSuperAdmin {
  219. return
  220. }
  221. member, err := l.models.SysProductMemberModel.FindOneByProductCodeUserId(ctx, ud.ProductCode, ud.UserId)
  222. if err != nil {
  223. if err != productmember.ErrNotFound {
  224. logx.WithContext(ctx).Errorf("userDetailsLoader: query member failed: %v", err)
  225. }
  226. return
  227. }
  228. ud.MemberType = member.MemberType
  229. }
  230. func (l *UserDetailsLoader) loadRoles(ctx context.Context, ud *UserDetails) {
  231. if ud.ProductCode == "" {
  232. return
  233. }
  234. roleIds, err := l.models.SysUserRoleModel.FindRoleIdsByUserId(ctx, ud.UserId)
  235. if err != nil || len(roleIds) == 0 {
  236. return
  237. }
  238. roles, err := l.models.SysRoleModel.FindByIds(ctx, roleIds)
  239. if err != nil {
  240. logx.WithContext(ctx).Errorf("userDetailsLoader: query roles failed: %v", err)
  241. return
  242. }
  243. ud.Roles = make([]RoleInfo, 0)
  244. minLevel := int64(math.MaxInt64)
  245. for _, r := range roles {
  246. if r.ProductCode == ud.ProductCode && r.Status == consts.StatusEnabled {
  247. ud.Roles = append(ud.Roles, RoleInfo{
  248. Id: r.Id,
  249. Name: r.Name,
  250. Remark: r.Remark,
  251. PermsLevel: r.PermsLevel,
  252. })
  253. if r.PermsLevel < minLevel {
  254. minLevel = r.PermsLevel
  255. }
  256. }
  257. }
  258. if minLevel < math.MaxInt64 {
  259. ud.MinPermsLevel = minLevel
  260. }
  261. }
  262. func (l *UserDetailsLoader) loadPerms(ctx context.Context, ud *UserDetails) {
  263. if ud.ProductCode == "" {
  264. return
  265. }
  266. // 超管 / ADMIN / DEVELOPER / 研发部门成员 → 全量权限
  267. if ud.IsSuperAdmin ||
  268. ud.MemberType == consts.MemberTypeAdmin ||
  269. ud.MemberType == consts.MemberTypeDeveloper ||
  270. ud.DeptType == consts.DeptTypeDev {
  271. codes, err := l.models.SysPermModel.FindAllCodesByProductCode(ctx, ud.ProductCode)
  272. if err != nil {
  273. logx.WithContext(ctx).Errorf("userDetailsLoader: query all perms failed: %v", err)
  274. }
  275. ud.Perms = codes
  276. return
  277. }
  278. // 普通成员:角色权限 + 用户附加权限 - 用户拒绝权限
  279. rolePermIds := make([]int64, 0)
  280. if len(ud.Roles) > 0 {
  281. roleIds := make([]int64, 0, len(ud.Roles))
  282. for _, r := range ud.Roles {
  283. roleIds = append(roleIds, r.Id)
  284. }
  285. ids, err := l.models.SysRolePermModel.FindPermIdsByRoleIds(ctx, roleIds)
  286. if err == nil {
  287. rolePermIds = ids
  288. }
  289. }
  290. allowIds, _ := l.models.SysUserPermModel.FindPermIdsByUserIdAndEffect(ctx, ud.UserId, consts.PermEffectAllow)
  291. denyIds, _ := l.models.SysUserPermModel.FindPermIdsByUserIdAndEffect(ctx, ud.UserId, consts.PermEffectDeny)
  292. denySet := make(map[int64]bool, len(denyIds))
  293. for _, id := range denyIds {
  294. denySet[id] = true
  295. }
  296. permIdSet := make(map[int64]bool)
  297. for _, id := range rolePermIds {
  298. if !denySet[id] {
  299. permIdSet[id] = true
  300. }
  301. }
  302. for _, id := range allowIds {
  303. if !denySet[id] {
  304. permIdSet[id] = true
  305. }
  306. }
  307. finalIds := make([]int64, 0, len(permIdSet))
  308. for id := range permIdSet {
  309. finalIds = append(finalIds, id)
  310. }
  311. if len(finalIds) > 0 {
  312. perms, err := l.models.SysPermModel.FindByIds(ctx, finalIds)
  313. if err == nil {
  314. codes := make([]string, 0, len(perms))
  315. for _, p := range perms {
  316. if p.Status == consts.StatusEnabled {
  317. codes = append(codes, p.Code)
  318. }
  319. }
  320. ud.Perms = codes
  321. }
  322. }
  323. }