CodeReview IDEA插件配套服务端使用教程
本篇内容主要给大家介绍下CodeReviewServer的具体部署方式与详细功能使用教程。
服务端安装部署
依赖条件
- JDK8+
- MySQL
- MongoDB
部署说明
您可以从本仓库的release version
中下载最新版本的二进制包,然后直接部署即可使用:
- 准备好MySQL、MongoDB
- 执行
initial_db.sql
对MySQL进行初始化操作 - 修改
config/application-PROD.properties
文件中的配置,填写正确的数据库连接信息 - 根据部署系统的不同,执行
start.bat
或者start.sh
,启动服务 - 访问
http://localhost:23560
可以查看到登录界面,使用预置账号codereview/123456
可以登录进入系统。
如果您是直接clone本代码仓库到本地,您可以按照如下方式即可轻松部署运行:
- 准备好MySQL、MongoDB
- 执行
initial_db.sql
对MySQL进行初始化操作 - 修改
application-PROD.properties
文件中的配置,填写正确的数据库连接信息 - 启动服务
- 访问
http://localhost:23560
可以查看到登录界面,使用预置账号codereview/123456
可以登录进入系统。
服务端使用教程
系统权限体系说明
系统的访问权限基于角色进行控制。默认情况下,系统预置了系统管理员
和普通用户
两种角色,其中系统管理员
拥有全部界面访问权限,而普通用户
可以访问与自己有关的评审数据的界面。
当然,管理员可以自行创建其他的角色,并指定每个角色可以访问的菜单界面,然后将角色绑定给具体用户即可。
用户管理
对系统的用户进行管理。系统用户管理采用的是预授权机制,即管理员必须要手动先创建好账号,然后才允许登录到系统内,暂未开放用户自行注册的能力。
用户创建完成后,默认的密码为123456
。为了安全期间,用户创建完成后,需手动修改下自己的登录密码。
修改密码方式:
- 点击右上角个人名称,选择
个人设置
- 在安全设置选项中,进行密码的修改操作
部门管理
在部门管理界面,支持录入树状层级化的组织部门信息。
项目管理
在本系统中,代码Review记录是以项目维度进行区分的,所以在正式使用本系统前,需先录入下对应项目信息。
注意:项目需要隶属于一个部门、当前每个项目仅支持隶属于唯一的一个部门,不支持多个部门共享同一个项目。
评审字段配置&字典值管理
关于此部分内容进行单独阐述,详情可以 点此查看
评审意见查看与管理
评审意见管理部分,支持查看团队成员提出的所有评审意见数据。这里的评审意见,支持在界面上手动添加,也支持从IDEA插件中直接上传到服务端。整个运作模式示意如下:
我的待办
这里可以看到别人提给自己的、尚未确认处理的review意见,可以在此界面进行确认处理操作。
这里有两种方式进行评审意见的确认。
- 在IDEA端拉取评审意见到本地,然后在本地IDEA中进行确认,然后提交确认结果到服务端。
具体操作方式可以 点此查看
- 直接在WEB界面端进行确认。
我提交的
这里可以看到当前登录用户提交的所有检视意见。
当然,如果你愿意,也可以不通过IDEA插件,直接在界面端创建评审意见(对于一些不使用IDEA作为主流开发工具的场景,倒也可以使用,比如前端代码的review):
我确认的
这里可以看到当前登录用户曾经确认处理过的所有评审意见列表。
全部数据
如果您是管理员角色,则您可以查看系统内所有的代码review记录数据,并可以对记录进行所有操作。如果您的系统对review数据有保密性要求,请慎重分配有权查看此界面的人员权限。
统计报表查看
即将开放…
配套IDEA插件
通过IDEA plugin marketplace获取并安装
这是最简单的一种方式,在IDEA插件市场搜索安装即可:
源码编译定制开发
您也可以直接获取IDEA配套源码,进行二次开发。
IDEA源码:
服务端后端源码:
前端Portal源码:
问题&建议
使用过程中,如果发现有bug或者有功能建议,欢迎提issue单,或者通过公众号@架构悟道
联系到作者,获取更为及时的支持。
当然,如果觉得本软件帮助到了您的工作,也欢迎支持我继续更新维护下去~
我是悟道,聊技术、又不仅仅聊技术~
如果觉得有用,请点赞 + 关注让我感受到您的支持。也可以关注下我的公众号【架构悟道】,获取更及时的更新。
期待与你一起探讨,一起成长为更好的自己。