{"id":15728748,"url":"https://github.com/flashvayne/rbac-spring-boot-starter","last_synced_at":"2025-03-13T03:30:40.444Z","repository":{"id":39903621,"uuid":"448865863","full_name":"flashvayne/rbac-spring-boot-starter","owner":"flashvayne","description":"基于RBAC (Resource-Based Access Control) 模型的用户资源权限管理组件","archived":false,"fork":false,"pushed_at":"2022-07-27T02:08:31.000Z","size":77,"stargazers_count":7,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-26T18:22:41.168Z","etag":null,"topics":["rbac","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flashvayne.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-17T11:27:56.000Z","updated_at":"2024-07-31T02:14:57.000Z","dependencies_parsed_at":"2022-09-26T22:11:17.051Z","dependency_job_id":null,"html_url":"https://github.com/flashvayne/rbac-spring-boot-starter","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashvayne%2Frbac-spring-boot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashvayne%2Frbac-spring-boot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashvayne%2Frbac-spring-boot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flashvayne%2Frbac-spring-boot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flashvayne","download_url":"https://codeload.github.com/flashvayne/rbac-spring-boot-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243335042,"owners_count":20274895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rbac","spring-boot"],"created_at":"2024-10-03T23:05:51.105Z","updated_at":"2025-03-13T03:30:40.113Z","avatar_url":"https://github.com/flashvayne.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Maven central](https://maven-badges.herokuapp.com/maven-central/io.github.flashvayne/rbac-spring-boot-starter/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.flashvayne/rbac-spring-boot-starter)\n# rbac-spring-boot-starter\n\n基于RBAC (Resource-Based Access Control) 的用户资源权限管理轻量级组件  \n详情参照博客 [blog](https://vayne.cc/2022/02/06/rbac-spring-boot-starter)\n# 使用说明：\n\n## 1.登录/Token生成：\n1.注入AuthUserService，调用authUserService.authentication(userId,password)方法可校验用户名密码，\n如检验通过，可通过rbacTokenService.generateTokenInfo(authUserInfo)方法生成Token信息,调用rbacTokenService.doGenerateToken(rbacTokenInfo)将token存入redis（或其他容器）。实例代码如下：\n```java\n@Autowired\nprivate AuthUserService authUserService;\n\n@Autowired\nprivate RbacTokenService RbacTokenService;\n\n@PostMapping(\"/login\")\n    public ResponseModel login(@RequestBody @Valid LoginDTO loginDTO) {\n        if (!rbacAuthUserService.authentication(loginDTO.getUserId(), loginDTO.getPassword())) {\n            return ResponseModel.fail(401, \"用户名或密码错误\", null);\n        }\n        AuthUserDTO authUserInfo = rbacAuthUserService.getAuthUserInfo(loginDTO.getUserId());\n\n        if (authUserInfo.getStatus() == 1) {\n            return ResponseModel.fail(\"登录失败，账号已被锁定\");\n        }\n        //如果用户/角色/资源/Token等信息有额外信息 可扩展到相应addition属性\n//        demoService.setAdditionProperties(authUserInfo);\n        RbacTokenInfo rbacTokenInfo = rbacTokenService.generateTokenInfo(authUserInfo);\n        if (rbacTokenService.doGenerateToken(rbacTokenInfo)) {\n            return ResponseModel.success(\"登录成功\", rbacTokenInfo);\n        } else {\n            return ResponseModel.fail(500, \"请求失败\", null);\n        }\n    }\n```\n\n## 2.鉴权：\n本组件基于Rbac用户-角色-资源三者进行权限管理。\n鉴权切入点是@RbacAuthorization注解，在需要鉴权的方法上使用此注解。\n此注解会检查token是否合法并将根据rbac_role_resource、rbac_user_role中配置的资源关系检查当前用户是否具有使用资源的权限（以请求的uri最为资源标识）。\n方法中可直接调用AuthUserUtils.get()获取当前用户信息。\n```java\n@RbacAuthorization\n@GetMapping(\"/list\")\npublic void list(@RequestParam Integer pageNum,@RequestParam Integer pageSize,\n        String param1,String param2){\n    log.info(\"当前用户：{}\",AuthUserUtils.get());\n    Page.start(pageNum,pageSize);\n    log.info(testService.list(param1,param2));\n}\n```\n如当前用户token不合法则返回Http 401 Unauthorized.\n如token合法但不具有\"/list\"接口资源权限，则返回Http 403 Forbidden.\n\n\n# 配置方法\n1.加载maven依赖\n```pom\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.github.flashvayne\u003c/groupId\u003e\n    \u003cartifactId\u003erbac-spring-boot-starter\u003c/artifactId\u003e\n    \u003cversion\u003e2.2.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n2.配置项：\n```yml\nrbac:\n  token-expire-time: 7200  #无操作2小时过期\n  token-name: authorization  #request header中token的变量名\n  redis-key-prefix: 'rbac:'\nspring:\n  redis:  #配置Redis信息（本组件默认使用Redis作为Token存储的中间件）\n    host: 127.0.0.1\n    port: 6379\n    timeout: 5000\n```\n3.执行本项目的schema中对应的SQL脚本建Rbac基础表  \n4.将BaseRbacMapper加入Mybatis扫描：  \n1)可通过继承基础Mapper并加入Mybatis扫描。\n```java\n@Mapper\npublic interface TestRbacMapper extends BaseRbacMapper {\n}\n```\n2)如果是MySQL数据源可直接将resources/mapper/RbacMapper-MySQL.xml复制到你的mapper-locations路径。  \n若无需自定义RbacMapper-MySQL.xml，可通过追加mapper-locations （如下方配置）直接扫描rbac jar包中的xml，这样就无需将xml复制到项目的mapper-locations路径下\n```yml\nmybatis:\n  mapper-locations:\n    - classpath*:/mapper/*.xml\n```\n其他数据源可参照RbacMapper-MySQL.xml进行实现\n\n\n# Demo项目：\n[Rbac-Demo](https://github.com/flashvayne/rbac-demo)\n\n# 扩展性：\n本组件使用@ConditionalOnMissingBean条件注解进行自动装配，所以开发者可直接重写本组件中的Bean并注入容器实现功能的重构。\n+ 可通过继承RbacAuthorizationAspect修改拦截器的实现。\n+ 可通过继承DefaultAuthUserServiceImpl或实现AuthUserService接口，来重写用户信息相关功能。\n+ 可通过继承DefaultTokenServiceImpl或实现TokenService接口，来重写Token服务相关功能。\n+ 用户/角色/资源/Token等DTO预留了addition属性，可扩展业务系统需要添加的信息（比如用户所属区县、角色所属机构等）\n\n# Tips：\n+ 本项目使用Redis作为Token保存的中间件，此举是为了直接分布式多台机器共享Token，如开发者不需要多级部署，可重写Token服务相关功能，重写方法见上方章节“扩展性”\n\n# 作者信息\nflashvayne\n\n邮箱: flashvayne@gmail.com\n\n博客: https://vayne.cc\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflashvayne%2Frbac-spring-boot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflashvayne%2Frbac-spring-boot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflashvayne%2Frbac-spring-boot-starter/lists"}