renren-security 快速开发平台技术文档
1. 安装指南
1.1 环境要求
- JDK版本: JDK17+
- 构建工具: Maven3.6+
- 数据库支持:
- MySQL8.0+
- Oracle 11g+
- SQLServer 2012+
- PostgreSQL 9.4+
- 达梦8
1.2 数据库准备
- 创建数据库
renren_security,确保编码为UTF-8 - 执行
renren-admin/db/mysql.sql脚本初始化数据
2. 项目安装方式
2.1 后端部署
# 克隆项目
git clone https://gitee.com/renrenio/renren-security.git
# 进入项目目录
cd renren-security
# 构建项目
mvn clean install
# 修改数据库配置(renren-admin/src/main/resources/application-dev.yml)
spring:
datasource:
url: jdbc:mysql://localhost:3306/renren_security?useUnicode=true&characterEncoding=UTF-8
username: your_username
password: your_password
# 启动后端服务(运行AdminApplication.java)
2.2 前端部署
- 进入
renren-ui目录 - 安装依赖:
npm install - 启动服务:
npm run dev - 访问地址:
http://localhost:8000
3. 项目使用说明
3.1 系统登录
- 访问地址:
http://localhost:8080/renren-admin - 默认账号:
admin - 默认密码:
admin
3.2 核心功能模块
-
系统管理:
- 用户管理
- 角色管理
- 菜单管理
- 部门管理
- 字典管理
-
定时任务:
- 任务管理
- 任务日志
-
文件存储:
- 支持七牛云、阿里云、腾讯云等云存储
-
系统监控:
- 系统日志
- 在线用户
3.3 代码生成器使用
- 启动
renren-generator模块 - 访问
http://localhost:8080/renren-generator - 配置生成参数:
- 表名
- 模块名
- 作者
- 包名
- 生成代码并下载
4. 项目API使用文档
4.1 认证接口
// 登录示例
POST /sys/login
Content-Type: application/json
{
"username": "admin",
"password": "admin",
"captcha": "验证码",
"uuid": "验证码UUID"
}
// 响应示例
{
"code": 0,
"msg": "success",
"token": "eyJhbGciOiJIUzI1NiJ9...",
"expire": 3600
}
4.2 数据权限API
@DataFilter
@GetMapping("/list")
public R list(@RequestParam Map<String, Object> params){
// 自动添加数据权限过滤条件
PageUtils page = userService.queryPage(params);
return R.ok().put("page", page);
}
4.3 Swagger文档
- 访问地址:
http://localhost:8080/renren-admin/doc.html - 包含所有API接口说明和测试功能
4.4 常用注解
| 注解 | 说明 |
|---|---|
@RequiresPermissions | 权限控制 |
@DataFilter | 数据权限过滤 |
@LogOperation | 操作日志记录 |
@Validator | 参数校验 |
5. 高级功能
5.1 定时任务配置
@Service("testTask")
public class TestTask implements ITask {
@Override
public void run(String params){
// 定时任务业务逻辑
}
}
5.2 云存储配置
修改application-dev.yml:
renren:
storage:
type: qiniu # 支持qiniu/aliyun/tx
qiniu:
access-key: your-access-key
secret-key: your-secret-key
bucket-name: your-bucket
domain: your-domain
5.3 XSS防护
@XssFilter
@PostMapping("/save")
public R save(@RequestBody UserEntity user){
// 自动过滤XSS脚本
userService.save(user);
return R.ok();
}
6. 注意事项
- 生产环境务必修改默认账号密码
- 定时任务表达式需符合Quartz规范
- 数据权限注解需配合部门管理使用
- 代码生成器生成的代码需二次检查
通过本文档,您应该能够顺利完成renren-security平台的安装部署和基本使用。如需更详细的技术支持,可参考项目Wiki或加入官方交流群。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



