基于Java的APIJSON角色扩展框架.zip

# 基于Java的APIJSON角色扩展框架 ## 项目概述 APIJSON本身的权限定义在枚举`RequestRole`中，且与框架本身的耦合度较高，如果想要在此基础上定义新的权限级别不是很方便。本项目通过定义一个新的接口`IRequestRole`，令`RequestRole`实现这个接口，再依次修改框架中其他相关联的位置，从而实现了一个可扩展的权限系统。 ## 主要功能 - **权限扩展**：通过接口`IRequestRole`实现权限枚举的可扩展性。 - **用户自定义权限**：用户可以注册自己的权限枚举类，并通过`IRequestRole.register`方法进行注册。 - **权限验证**：在`AbstractVerifier`中增加`convertStringToIRequestRole`方法，从`String[]`转换到`IRequestRole[]`，并在`verifyAccess`方法中进行权限验证。 ## 主要修改 - 建立`IRequestRole`接口（位于`apijson.orm`包中）。 - 令`RequestRole`实现`IRequestRole`，并将其内的`get`方法移至`IRequestRole`中实现。 - `MethodAccess`注解返回`String[]`，因为`IRequestRole[]`编译时不确定。 - `AbstractVerifier`中增加`convertStringToIRequestRole`方法，从`String[]`转换到`IRequestRole[]`。`verifyAccess`方法中的switch转换为if else。 - `APIJSONApplication`的static块中使用`IRequestRole.register`注册内建的`RequestRole`。 ## 用户使用指南 1. 定义自己的权限枚举类（可参照`apijson.demo.config.MyRole`）。 2. 在`DemoApplication`的static块中注册自己的权限枚举类。 3. 在自己的用户类（`model.User`）中添加`List<String> role`属性，并添加对应的getter, setter方法。 4. 重载`AbstractVerifier.verifyAccess`，补全一部分框架中未完成的鉴权逻辑。 5. 在数据库`Access`表中完成对应配置。 6. 在调用时先登录，然后用`@role`声明对应的权限。 ## 示例项目 本项目中内置了改动后APIJSON ORM和Framework的代码，导入Intellij IDEA或其他开发工具后应可以直接运行`DemoApplication`。 ### 场景 本项目模拟一个选课系统，为简化场景，其中业务表仅有`Course`（课程）一张。 ### 权限配置 基于以上场景，对`Course`表配置权限如下： - GET/GETS/HEAD/HEADS：["STUDENT", "TEACHER","PRINCIPAL"] - POST/DELETE：["TEACHER"] - PUT：["OWNER","PRINCIPAL"] ### 可用用户 内置了四个用户，密码均为`1234`。用户的公开信息存储在`User`表中，私密信息存储在`Credential`表中。 | id | username | password | role | | ---- | --------- | -------- | ---------------------- | | 1 | jerry | 1234 | ["STUDENT", "TEACHER"] | | 2 | neko | 1234 | ["STUDENT"] | | 3 | doge | 1234 | ["TEACHER"] | | 4 | principal | 1234 | ["PRINCIPAL"] | ### 初始化 1. 在MySQL / MariaDB中执行项目根目录`initdb.sql`，并在`DemoSQLConfig`中配置相关连接属性。 2. （可选）使用Postman，导入项目根目录的`role_extend.postman_collection.json`，内有主要的几个测试接口。 3. 使用IDEA或其他开发工具打开项目目录，运行`DemoApplication`。 ### 部分调用示例 登录 /login ```json { "username":"jerry", "password":"1234" } ``` 获取课程 /get ```json { "[]": { "Course": { "@role": "TEACHER" } } } ``` 课程计数 /head ```json { "Course": { "@role": "STUDENT" } } ``` 新建课程 /post ```json { "Course": { "sysid": "CS244", "name": "分布式系统", "teacher": "t1", "location": "二教222", "capacity": 80, "@role": "TEACHER" // 换成 STUDENT 就会鉴权失败了 }, "tag": "Course" } ``` 修改课程 /put ```json { "Course": { "id": 1627252238116, "capacity": 20, "@role": "OWNER" // 或者 "PRINCIPLE" }, "tag": "Course" } ``` 删除课程 /delete ```json { "Course": { "id": 1627772387598, "@role": "TEACHER" }, "tag": "Course" } ``` ## 问题 - MethodAccess 类型修改，不兼容旧的实现，升级的时候需要手动修改。 - 引入了一些类型不安全，主要是在 `IRequestRole` 里有对 Class 的直接操作。 ## 开发环境 - Windows 10 - JDK 13 - MariaDB 10.5.9 ## 贡献 欢迎提交Issue和PR，一起完善这个项目！ ## 许可证 本项目遵循Apache License Version 2.0开源协议。